create-harper 0.0.4 → 0.0.5

package/template-studio/resources/exampleTable.js

@@ -0,0 +1,14 @@
+import { tables } from 'harperdb';
+
+export class ExampleTable extends tables.ExampleTable {
+	// we can define our own custom POST handler
+	post(content) {
+		// do something with the incoming content;
+		return super.post(content);
+	}
+	// or custom GET handler
+	get() {
+		// we can modify this resource before returning
+		return super.get();
+	}
+}

package/template-studio/resources/greeting.js

@@ -0,0 +1,10 @@
+import { Resource } from 'harperdb';
+
+export class Greeting extends Resource {
+	// a "Hello, world!" handler
+	static loadAsInstance = false; // use the updated/newer Resource API
+
+	get() {
+		return { greeting: 'Hello, world!' };
+	}
+}

package/{template-vanilla-ts/schema.graphql → template-studio/schemas/exampleTable.graphql}

@@ -1,6 +1,6 @@
 ## Here we can define any tables in our database. This example shows how we define a type as a table using
 ## the type name as the table name and specifying it is an "export" available in the REST and other external protocols.
-type TableName @table @export {
+type ExampleTable @table @export {
 	id: ID @primaryKey # Here we define primary key (must be one)
 	name: String # we can define any other attributes here
 	tag: String @indexed # we can specify any attributes that should be indexed

package/template-studio-ts/config.yaml

@@ -13,11 +13,11 @@ rest: true
 
 # These reads GraphQL schemas to define the schema of database/tables/attributes.
 graphqlSchema:
-  files: 'schema.graphql'
+  files: 'schemas/*.graphql'
 
 # Loads JavaScript modules such that their exports are exported as resources
 jsResource:
-  files: 'resources.ts'
+  files: 'resources/*.ts'
 
 # Serve the static files from the web directory as a web application
 static:

package/template-studio-ts/resources/exampleSocket.ts

@@ -0,0 +1,41 @@
+import { type IterableEventQueue, RequestTarget, Resource, tables, type User } from 'harperdb';
+
+interface ExampleSocketRecord {
+	id: string;
+	type?: 'get' | 'put';
+	name: string;
+	tag: string;
+}
+
+export class ExampleSocket extends Resource<ExampleSocketRecord> {
+	static loadAsInstance = false;
+
+	// This customizes handling the socket connections; tables can have this method too!
+	async *connect(
+		target: RequestTarget,
+		incomingMessages: IterableEventQueue<ExampleSocketRecord>,
+	): AsyncIterable<ExampleSocketRecord> {
+		const subscription = await tables.ExampleTable.subscribe(target);
+		if (!incomingMessages) {
+			// Server sent events, no incoming messages!
+			// Subscribe to changes to the table.
+			return subscription;
+		}
+		for await (let message of incomingMessages) {
+			const { type, id, name, tag } = message;
+			switch (type) {
+				case 'get':
+					const loaded = await tables.ExampleTable.get(id);
+					yield {
+						type: 'get',
+						id,
+						...(loaded ? loaded : {}),
+					};
+					break;
+				case 'put':
+					await tables.ExampleTable.put(id, { name, tag });
+					break;
+			}
+		}
+	}
+}

package/template-studio-ts/resources/exampleTable.ts

@@ -0,0 +1,20 @@
+import { type RequestTargetOrId, tables } from 'harperdb';
+
+export interface TableNameRecord {
+	id: string;
+	name: string;
+	tag: string;
+}
+
+export class ExampleTable extends tables.ExampleTable<TableNameRecord> {
+	// we can define our own custom POST handler
+	async post(target: RequestTargetOrId, newRecord: Omit<TableNameRecord, 'id'>) {
+		// do something with the incoming content;
+		return super.post(target, newRecord);
+	}
+	// or custom GET handler
+	async get(target: RequestTargetOrId): Promise<TableNameRecord> {
+		// we can modify this resource before returning
+		return super.get(target);
+	}
+}

package/{template-vanilla-ts/resources.ts → template-studio-ts/resources/greeting.ts}

@@ -1,28 +1,5 @@
 import { type RecordObject, type RequestTargetOrId, Resource } from 'harperdb';
 
-/** Here we can define any JavaScript-based resources and extensions to tables
-import { tables, type RequestTarget } from 'harperdb';
-
-interface TableNameRecord {
-	id: string;
-	name: string;
-	tag: string;
-}
-
-export class TableName extends tables.TableName<TableNameRecord> {
-	// we can define our own custom POST handler
-	async post(target: RequestTargetOrId, newRecord: Omit<TableNameRecord, 'id'>) {
-		// do something with the incoming content;
-		return super.post(target, newRecord);
-	}
-	// or custom GET handler
-	async get(target: RequestTarget): Promise<TableNameRecord> {
-		// we can modify this resource before returning
-		return super.get(target);
-	}
-}
-*/
-
 interface GreetingRecord {
 	greeting: string;
 }

package/template-studio-ts/{schema.graphql → schemas/exampleTable.graphql}

@@ -1,6 +1,6 @@
 ## Here we can define any tables in our database. This example shows how we define a type as a table using
 ## the type name as the table name and specifying it is an "export" available in the REST and other external protocols.
-type TableName @table @export {
+type ExampleTable @table @export {
 	id: ID @primaryKey # Here we define primary key (must be one)
 	name: String # we can define any other attributes here
 	tag: String @indexed # we can specify any attributes that should be indexed

package/template-vanilla/README.md

@@ -38,7 +38,7 @@ Take a look at the [default configuration](./config.yaml), which specifies how f
 
 The [schema.graphql](./schema.graphql) is the 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.js](./resources.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+The [resources.js](resources/greeting.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
 
 ## Deployment
 

package/template-vanilla/config.yaml

@@ -13,11 +13,11 @@ rest: true
 
 # These reads GraphQL schemas to define the schema of database/tables/attributes.
 graphqlSchema:
-  files: 'schema.graphql'
+  files: 'schemas/*.graphql'
 
 # Loads JavaScript modules such that their exports are exported as resources
 jsResource:
-  files: 'resources.js'
+  files: 'resources/*.js'
 
 # Serve the static files from the web directory as a web application
 static:

package/template-vanilla/resources/exampleSocket.js

@@ -0,0 +1,34 @@
+import { Resource, tables } from 'harperdb';
+
+export class ExampleSocket extends Resource {
+	static loadAsInstance = false;
+
+	// This customizes handling the socket connections; tables can have this method too!
+	async *connect(
+		target,
+		incomingMessages,
+	) {
+		const subscription = await tables.ExampleTable.subscribe(target);
+		if (!incomingMessages) {
+			// Server sent events, no incoming messages!
+			// Subscribe to changes to the table.
+			return subscription;
+		}
+		for await (let message of incomingMessages) {
+			const { type, id, name, tag } = message;
+			switch (type) {
+				case 'get':
+					const loaded = await tables.ExampleTable.get(id);
+					yield {
+						type: 'get',
+						id,
+						...(loaded ? loaded : {}),
+					};
+					break;
+				case 'put':
+					await tables.ExampleTable.put(id, { name, tag });
+					break;
+			}
+		}
+	}
+}

package/template-vanilla/resources/exampleTable.js

@@ -0,0 +1,14 @@
+import { tables } from 'harperdb';
+
+export class ExampleTable extends tables.ExampleTable {
+	// we can define our own custom POST handler
+	post(content) {
+		// do something with the incoming content;
+		return super.post(content);
+	}
+	// or custom GET handler
+	get() {
+		// we can modify this resource before returning
+		return super.get();
+	}
+}

package/template-vanilla/resources/greeting.js

@@ -0,0 +1,10 @@
+import { Resource } from 'harperdb';
+
+export class Greeting extends Resource {
+	// a "Hello, world!" handler
+	static loadAsInstance = false; // use the updated/newer Resource API
+
+	get() {
+		return { greeting: 'Hello, world!' };
+	}
+}

package/template-vanilla/schemas/exampleTable.graphql

@@ -0,0 +1,7 @@
+## Here we can define any tables in our database. This example shows how we define a type as a table using
+## the type name as the table name and specifying it is an "export" available in the REST and other external protocols.
+type ExampleTable @table @export {
+	id: ID @primaryKey # Here we define primary key (must be one)
+	name: String # we can define any other attributes here
+	tag: String @indexed # we can specify any attributes that should be indexed
+}

package/template-vanilla-ts/README.md

@@ -36,9 +36,9 @@ For more information on Harper Components, see the [Components documentation](ht
 
 Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
 
-The [schema.graphql](./schema.graphql) is the 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 [schema.graphql](schemas/exampleTable.graphql) is the 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.js](resources.ts) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+The [resources.js](resources/greeting.ts) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
 
 ## Deployment
 

package/template-vanilla-ts/config.yaml

@@ -13,11 +13,11 @@ rest: true
 
 # These reads GraphQL schemas to define the schema of database/tables/attributes.
 graphqlSchema:
-  files: 'schema.graphql'
+  files: 'schemas/*.graphql'
 
 # Loads JavaScript modules such that their exports are exported as resources
 jsResource:
-  files: 'resources.ts'
+  files: 'resources/*.ts'
 
 # Serve the static files from the web directory as a web application
 static:

package/template-vanilla-ts/resources/exampleSocket.ts

@@ -0,0 +1,41 @@
+import { type IterableEventQueue, RequestTarget, Resource, tables, type User } from 'harperdb';
+
+interface ExampleSocketRecord {
+	id: string;
+	type?: 'get' | 'put';
+	name: string;
+	tag: string;
+}
+
+export class ExampleSocket extends Resource<ExampleSocketRecord> {
+	static loadAsInstance = false;
+
+	// This customizes handling the socket connections; tables can have this method too!
+	async *connect(
+		target: RequestTarget,
+		incomingMessages: IterableEventQueue<ExampleSocketRecord>,
+	): AsyncIterable<ExampleSocketRecord> {
+		const subscription = await tables.ExampleTable.subscribe(target);
+		if (!incomingMessages) {
+			// Server sent events, no incoming messages!
+			// Subscribe to changes to the table.
+			return subscription;
+		}
+		for await (let message of incomingMessages) {
+			const { type, id, name, tag } = message;
+			switch (type) {
+				case 'get':
+					const loaded = await tables.ExampleTable.get(id);
+					yield {
+						type: 'get',
+						id,
+						...(loaded ? loaded : {}),
+					};
+					break;
+				case 'put':
+					await tables.ExampleTable.put(id, { name, tag });
+					break;
+			}
+		}
+	}
+}

package/template-vanilla-ts/resources/exampleTable.ts

@@ -0,0 +1,20 @@
+import { type RequestTargetOrId, tables } from 'harperdb';
+
+export interface TableNameRecord {
+	id: string;
+	name: string;
+	tag: string;
+}
+
+export class ExampleTable extends tables.ExampleTable<TableNameRecord> {
+	// we can define our own custom POST handler
+	async post(target: RequestTargetOrId, newRecord: Omit<TableNameRecord, 'id'>) {
+		// do something with the incoming content;
+		return super.post(target, newRecord);
+	}
+	// or custom GET handler
+	async get(target: RequestTargetOrId): Promise<TableNameRecord> {
+		// we can modify this resource before returning
+		return super.get(target);
+	}
+}

package/{template-studio-ts/resources.ts → template-vanilla-ts/resources/greeting.ts}

@@ -1,28 +1,5 @@
 import { type RecordObject, type RequestTargetOrId, Resource } from 'harperdb';
 
-/** Here we can define any JavaScript-based resources and extensions to tables
-import { tables, type RequestTarget } from 'harperdb';
-
-interface TableNameRecord {
-	id: string;
-	name: string;
-	tag: string;
-}
-
-export class TableName extends tables.TableName<TableNameRecord> {
-	// we can define our own custom POST handler
-	async post(target: RequestTargetOrId, newRecord: Omit<TableNameRecord, 'id'>) {
-		// do something with the incoming content;
-		return super.post(target, newRecord);
-	}
-	// or custom GET handler
-	async get(target: RequestTarget): Promise<TableNameRecord> {
-		// we can modify this resource before returning
-		return super.get(target);
-	}
-}
-*/
-
 interface GreetingRecord {
 	greeting: string;
 }

package/template-vanilla-ts/schemas/exampleTable.graphql

@@ -0,0 +1,7 @@
+## Here we can define any tables in our database. This example shows how we define a type as a table using
+## the type name as the table name and specifying it is an "export" available in the REST and other external protocols.
+type ExampleTable @table @export {
+	id: ID @primaryKey # Here we define primary key (must be one)
+	name: String # we can define any other attributes here
+	tag: String @indexed # we can specify any attributes that should be indexed
+}

package/template-barebones/README.md

@@ -1,7 +0,0 @@
-# your-project-name-here
-
-This repository is intended for use alongside the Harper Learn ["Getting Started > Create Your First Application"](https://docs.harperdb.io/learn/getting-started/create-your-first-application) guide.
-
-The `main` branch is the starting point for the guide.
-
-The `completed` branch is the completed code example if you need to check your work.

package/template-barebones/_aiignore

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

package/template-barebones/_env

@@ -1,3 +0,0 @@
-CLI_TARGET_USERNAME='your-cluster-username-here'
-CLI_TARGET_PASSWORD='your-cluster-password-here'
-CLI_TARGET='your-fabric.harper.fast-cluster-url-here'

package/template-barebones/_env.example

@@ -1,3 +0,0 @@
-CLI_TARGET_USERNAME='YOUR_CLUSTER_USERNAME'
-CLI_TARGET_PASSWORD='YOUR_CLUSTER_PASSWORD'
-CLI_TARGET='YOUR_FABRIC.HARPER.FAST_CLUSTER_URL_HERE'

package/template-barebones/_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-barebones/config.yaml

@@ -1,7 +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
-
-# Follow along with https://github.com/HarperFast/create-your-first-application to learn more!

package/template-barebones/graphql.config.yml

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

package/template-barebones/package.json

@@ -1,14 +0,0 @@
-{
-	"name": "your-package-name-here",
-	"version": "1.0.0",
-	"description": "Your new Harper app",
-	"type": "module",
-	"scripts": {
-		"start": "harperdb run .",
-		"dev": "harperdb dev .",
-		"deploy": "npx -y dotenv-cli -- harperdb deploy . restart=rolling replicated=true"
-	},
-	"devDependencies": {
-		"harperdb": "^4.7.15"
-	}
-}

package/template-barebones/schema.graphql

@@ -1 +0,0 @@
-## Table Schemas

package/template-react/resources.js

@@ -1,27 +0,0 @@
-import { Resource } from 'harperdb';
-
-/** Here we can define any JavaScript-based resources and extensions to tables
-import {tables} from 'harperdb';
-
-export class MyCustomResource extends tables.TableName {
-	// we can define our own custom POST handler
-	post(content) {
-		// do something with the incoming content;
-		return super.post(content);
-	}
-	// or custom GET handler
-	get() {
-		// we can modify this resource before returning
-		return super.get();
-	}
-}
- */
-// we can also define a custom resource without a specific table
-export class Greeting extends Resource {
-	// a "Hello, world!" handler
-	static loadAsInstance = false; // use the updated/newer Resource API
-
-	get() {
-		return { greeting: 'Hello, world!' };
-	}
-}

package/template-react/schema.graphql

@@ -1,5 +0,0 @@
-type ToDoList @table @export {
-	id: ID @primaryKey
-	status: String @index
-	description: String
-}

package/template-react-ts/schema.graphql

@@ -1,5 +0,0 @@
-type ToDoList @table @export {
-	id: ID @primaryKey
-	status: String @index
-	description: String
-}

package/template-studio/resources.js

@@ -1,27 +0,0 @@
-import { Resource } from 'harperdb';
-
-/** Here we can define any JavaScript-based resources and extensions to tables
-import {tables} from 'harperdb';
-
-export class MyCustomResource extends tables.TableName {
-	// we can define our own custom POST handler
-	post(content) {
-		// do something with the incoming content;
-		return super.post(content);
-	}
-	// or custom GET handler
-	get() {
-		// we can modify this resource before returning
-		return super.get();
-	}
-}
- */
-// we can also define a custom resource without a specific table
-export class Greeting extends Resource {
-	// a "Hello, world!" handler
-	static loadAsInstance = false; // use the updated/newer Resource API
-
-	get() {
-		return { greeting: 'Hello, world!' };
-	}
-}