create-harper 0.5.0 → 0.6.0

package/lib/fs/copyDir.js

@@ -1,18 +1,27 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { copy } from './copy.js';
+import { copyFile } from './copyFile.js';
 
 /**
  * Recursively copies a directory from source to destination.
  *
  * @param {string} srcDir - The source directory path.
  * @param {string} destDir - The destination directory path.
+ * @param {(src: string, dest: string) => boolean} [filter] - An optional filter function that returns true if the file should be included.
+ * @param {Record<string, string> | ((content: string, sourcePath: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
  */
-export function copyDir(srcDir, destDir) {
+export function copyDir(srcDir, destDir, filter, substitutions) {
 	fs.mkdirSync(destDir, { recursive: true });
 	for (const file of fs.readdirSync(srcDir)) {
 		const srcFile = path.resolve(srcDir, file);
 		const destFile = path.resolve(destDir, file);
-		copy(srcFile, destFile);
+		if (filter === undefined || filter(srcFile, destFile)) {
+			if (fs.lstatSync(srcFile).isDirectory()) {
+				fs.mkdirSync(destFile, { recursive: true });
+				copyDir(srcFile, destFile, substitutions);
+			} else {
+				copyFile(srcFile, destFile, substitutions);
+			}
+		}
 	}
 }

package/lib/fs/copyFile.js

@@ -0,0 +1,28 @@
+import fs from 'node:fs';
+import colors from 'picocolors';
+
+const {
+	gray,
+	green,
+} = colors;
+
+/**
+ * Reads a template file, applies string substitutions, and writes the result to a target path.
+ *
+ * @param {string} sourcePath - The path to the source template file.
+ * @param {string} targetPath - The path where the processed file will be written.
+ * @param {Record<string, string> | ((content: string, sourcePath: string, targetPath: string) => string)} [substitutions] - A mapping of strings to replace or a function that returns the updated content.
+ */
+export function copyFile(sourcePath, targetPath, substitutions) {
+	let updatedContent = fs.readFileSync(sourcePath, 'utf-8');
+	if (typeof substitutions === 'function') {
+		updatedContent = substitutions(updatedContent, sourcePath, targetPath);
+	} else if (substitutions) {
+		for (const variableName in substitutions) {
+			updatedContent = updatedContent.replaceAll(variableName, substitutions[variableName]);
+		}
+	}
+
+	console.log(' + ' + green(targetPath) + gray(' from ' + sourcePath));
+	fs.writeFileSync(targetPath, updatedContent);
+}

package/lib/fs/crawlTemplateDir.js

@@ -1,14 +1,14 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { renameFiles } from '../constants/renameFiles.js';
-import { applyAndWriteTemplateFile } from './applyAndWriteTemplateFile.js';
+import { copyFile } from './copyFile.js';
 
 /**
  * Recursively crawls a template directory and copies files to the target root, applying substitutions and respecting exclusions.
  *
  * @param {string} root - The current target directory.
  * @param {string} dir - The current source directory in the template.
- * @param {Record<string, string>} substitutions - A mapping of strings to replace in file contents.
+ * @param {Record<string, string> | ((content: string) => string)} substitutions - A mapping of strings to replace or a function that returns the updated content.
  * @param {string[]} [excludedFiles] - A list of relative paths to exclude from copying.
  * @param {string} [templateRootDir] - The absolute path to the root of the template directory (internal).
  */
@@ -27,7 +27,7 @@ export function crawlTemplateDir(root, dir, substitutions, excludedFiles = [], t
 			fs.mkdirSync(targetPath, { recursive: true });
 			crawlTemplateDir(targetPath, templatePath, substitutions, excludedFiles, templateRootDir);
 		} else {
-			applyAndWriteTemplateFile(targetPath, templatePath, substitutions);
+			copyFile(templatePath, targetPath, substitutions);
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-harper",
-	"version": "0.5.0",
+	"version": "0.6.0",
 	"type": "module",
 	"author": {
 		"name": "HarperDB",
@@ -16,8 +16,6 @@
 		"!lib/**/*.test.js",
 		"template-react/",
 		"template-react-ts/",
-		"template-studio/",
-		"template-studio-ts/",
 		"template-vanilla/",
 		"template-vanilla-ts/"
 	],

package/template-react/README.md

@@ -1,8 +1,12 @@
 # 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), which can be done quickly:
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper):
 
 ```sh
 npm install -g harperdb
@@ -16,26 +20,54 @@ Then you can start your app:
 npm run dev
 ```
 
-Navigate to [http://localhost:9926](http://localhost:9926) in a browser and view the functional web application.
+### Define Your Schema
 
-For more information about getting started with HarperDB and building applications, see our [getting started guide](https://docs.harperdb.io/docs).
+The [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
 
-For more information on Harper Components, see the [Components documentation](https://docs.harperdb.io/docs/reference/components).
+Open your [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) to take a look at an example schema. You can add as many table definitions to a single schema file as you want. You can also create one file per schema.
 
-Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
+These schemas are the heart of a great Harper app. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have. REST endpoints will get stood up for any table that you `@export`.
+
+### Add Custom Endpoints
+
+The [resources/greeting.js](./resources/greeting.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
 
-The [schemas/exampleTable.graphql](schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+### View Your Website
 
-The [resources/greeting.js](resources/greeting.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+Pop open [http://localhost:9926](http://localhost:9926) to view [web/index.html](./web/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.
 
-Make sure you've configured your [.env](.env) file with your secure cluster credentials. Don't commit this file to source control!
+Make sure you've configured your [.env](./.env) file with your secure cluster credentials. Don't commit this file to source control!
 
 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-react-ts/README.md

@@ -1,8 +1,12 @@
 # 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), which can be done quickly:
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper):
 
 ```sh
 npm install -g harperdb
@@ -16,26 +20,56 @@ Then you can start your app:
 npm run dev
 ```
 
-Navigate to [http://localhost:9926](http://localhost:9926) in a browser and view the functional web application.
+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.
 
-For more information about getting started with HarperDB and building applications, see our [getting started guide](https://docs.harperdb.io/docs).
+### Define Your Schema
 
-For more information on Harper Components, see the [Components documentation](https://docs.harperdb.io/docs/reference/components).
+The [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
 
-Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
+Open your [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) to take a look at an example schema. You can add as many table definitions to a single schema file as you want. You can also create one file per schema.
+
+These schemas are the heart of a great Harper app. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have. REST endpoints will get stood up for any table that you `@export`.
+
+### Add Custom Endpoints
+
+The [resources/greeting.ts](./resources/greeting.ts) provides a template for defining TypeScript resource classes, for customized application logic in your endpoints.
+
+### View Your Website
+
+Pop open [http://localhost:9926](http://localhost:9926) to view [web/index.html](./web/index.html) in your browser.
+
+### Use Your API
+
+Test your application works by querying the `/Greeting` endpoint:
 
-The [schemas/exampleTable.graphql](schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+```sh
+curl http://localhost:9926/Greeting
+```
+
+You should see the following:
 
-The [resources/greeting.ts](resources/greeting.ts) provides a template for defining TypeScript resource classes, for customized application logic in your endpoints.
+```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.
 
-Make sure you've configured your [.env](.env) file with your secure cluster credentials. Don't commit this file to source control!
+Make sure you've configured your [.env](./.env) file with your secure cluster credentials. Don't commit this file to source control!
 
 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-vanilla/README.md

@@ -1,8 +1,12 @@
 # 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), which can be done quickly:
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper):
 
 ```sh
 npm install -g harperdb
@@ -16,6 +20,24 @@ Then you can start your app:
 npm run dev
 ```
 
+### Define Your Schema
+
+The [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+
+Open your [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) to take a look at an example schema. You can add as many table definitions to a single schema file as you want. You can also create one file per schema.
+
+These schemas are the heart of a great Harper app. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have. REST endpoints will get stood up for any table that you `@export`.
+
+### Add Custom Endpoints
+
+The [resources/greeting.js](./resources/greeting.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+
+### View Your Website
+
+Pop open [http://localhost:9926](http://localhost:9926) to view [web/index.html](./web/index.html) in your browser.
+
+### Use Your API
+
 Test your application works by querying the `/Greeting` endpoint:
 
 ```sh
@@ -28,26 +50,24 @@ You should see the following:
 { "greeting": "Hello, world!" }
 ```
 
-Navigate to [http://localhost:9926](http://localhost:9926) in a browser and view the functional web application.
-
-For more information about getting started with HarperDB 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).
+### Configure Your App
 
 Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
 
-The [schemas/exampleTable.graphql](schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
-
-The [resources/greeting.js](resources/greeting.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
-
 ## Deployment
 
 When you are ready, head to [https://fabric.harper.fast/](https://fabric.harper.fast/), log in to your account, and create a cluster.
 
-Make sure you've configured your [.env](.env) file with your secure cluster credentials. Don't commit this file to source control!
+Make sure you've configured your [.env](./.env) file with your secure cluster credentials. Don't commit this file to source control!
 
 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-vanilla-ts/README.md

@@ -1,8 +1,12 @@
 # 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), which can be done quickly:
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper):
 
 ```sh
 npm install -g harperdb
@@ -16,6 +20,26 @@ Then you can start your app:
 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
+
+The [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+
+Open your [schemas/exampleTable.graphql](./schemas/exampleTable.graphql) to take a look at an example schema. You can add as many table definitions to a single schema file as you want. You can also create one file per schema.
+
+These schemas are the heart of a great Harper app. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have. REST endpoints will get stood up for any table that you `@export`.
+
+### Add Custom Endpoints
+
+The [resources/greeting.ts](./resources/greeting.ts) provides a template for defining TypeScript resource classes, for customized application logic in your endpoints.
+
+### View Your Website
+
+Pop open [http://localhost:9926](http://localhost:9926) to view [web/index.html](./web/index.html) in your browser.
+
+### Use Your API
+
 Test your application works by querying the `/Greeting` endpoint:
 
 ```sh
@@ -28,26 +52,24 @@ You should see the following:
 { "greeting": "Hello, world!" }
 ```
 
-Navigate to [http://localhost:9926](http://localhost:9926) in a browser and view the functional web application.
-
-For more information about getting started with HarperDB 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).
+### Configure Your App
 
 Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
 
-The [schemas/exampleTable.graphql](schemas/exampleTable.graphql) is an example table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
-
-The [resources/greeting.ts](resources/greeting.ts) provides a template for defining TypeScript resource classes, for customized application logic in your endpoints.
-
 ## Deployment
 
 When you are ready, head to [https://fabric.harper.fast/](https://fabric.harper.fast/), log in to your account, and create a cluster.
 
-Make sure you've configured your [.env](.env) file with your secure cluster credentials. Don't commit this file to source control!
+Make sure you've configured your [.env](./.env) file with your secure cluster credentials. Don't commit this file to source control!
 
 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/lib/fs/applyAndWriteTemplateFile.js

@@ -1,16 +0,0 @@
-import fs from 'node:fs';
-
-/**
- * Reads a template file, applies string substitutions, and writes the result to a target path.
- *
- * @param {string} targetPath - The path where the processed file will be written.
- * @param {string} templatePath - The path to the source template file.
- * @param {Record<string, string>} substitutions - A mapping of strings to replace in the file content.
- */
-export function applyAndWriteTemplateFile(targetPath, templatePath, substitutions) {
-	let updatedContent = fs.readFileSync(templatePath, 'utf-8');
-	for (const variableName in substitutions) {
-		updatedContent = updatedContent.replaceAll(variableName, substitutions[variableName]);
-	}
-	fs.writeFileSync(targetPath, updatedContent);
-}

package/lib/fs/copy.js

@@ -1,17 +0,0 @@
-import fs from 'node:fs';
-import { copyDir } from './copyDir.js';
-
-/**
- * Copies a file or directory from source to destination.
- *
- * @param {string} src - The source path.
- * @param {string} dest - The destination path.
- */
-export function copy(src, dest) {
-	const stat = fs.statSync(src);
-	if (stat.isDirectory()) {
-		copyDir(src, dest);
-	} else {
-		fs.copyFileSync(src, dest);
-	}
-}

package/template-studio/README.md

@@ -1,34 +0,0 @@
-# your-project-name-here
-
-Your new app is now deployed and running on Harper Fabric!
-
-Here's what you should do next:
-
-### 1. Define Your Schema
-
-Open your [schema.graphql](./schema.graphql) and tap [+ New Table](./schema.graphql?ShowNewTableModal=true). This is
-your table schema definition, and is the heart of a great Harper app. This is the main starting point for defining your
-[database schema](./databases), specifying which tables you want and what attributes/fields they should have. REST
-endpoints will get stood up for any table that you `@export`.
-
-### 2. Add Custom Endpoints
-
-The [resources.js](./resources.js) provides a template for defining JavaScript resource classes for customized
-application logic in your endpoints.
-
-### 3. View Your Website
-
-Pop open [http://localhost:9926](http://localhost:9926) to view [web/index.html](./web/index.html) in your browser.
-
-### 4. Use Your API
-
-Head to the [APIs](./apis) tab to explore your endpoints and exercise them. You can click the "Authenticate" button to
-see what different users will be able to access through your API.
-
-## 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-studio/_aiignore

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

package/template-studio/_gitignore

@@ -1,147 +0,0 @@
-.DS_Store
-
-#
-# 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-studio/config.yaml

@@ -1,24 +0,0 @@
-# yaml-language-server: $schema=./node_modules/harperdb/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/*.js'
-
-# Serve the static files from the web directory as a web application
-static:
-  files: 'web/*'

package/template-studio/graphql.config.yml

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