@harperfast/template-react-ts-studio 0.11.0 → 0.12.0

package/AGENTS.md

@@ -4,7 +4,7 @@ This repository contains "skills" that guide AI agents in developing Harper appl
 
 ## Available Skills
 
-- [Adding Tables](skills/adding-tables.md): Learn how to define schemas and enable automatic REST APIs for your database tables.
+- [Adding Tables with Schemas](skills/adding-tables-with-schemas.md): Learn how to define schemas and enable automatic REST APIs for your database tables with schema .graphql files in Harper.
 - [Automatic REST APIs](skills/automatic-rest-apis.md): Details on the CRUD endpoints automatically generated for exported tables.
 - [Querying REST APIs](skills/querying-rest-apis.md): How to use filters, operators, sorting, and pagination in REST requests.
 - [Programmatic Table Requests](skills/programmatic-table-requests.md): How to use filters, operators, sorting, and pagination in programmatic table requests.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harperfast/template-react-ts-studio",
-	"version": "0.11.0",
+	"version": "0.12.0",
 	"type": "module",
 	"repository": "github:HarperFast/create-harper",
 	"scripts": {},

package/resources/README.md

@@ -0,0 +1,11 @@
+# Resources
+
+The [schemas you define in .GraphQL files](../skills/adding-tables-with-schemas.md) will [automatically stand-up REST APIs](../skills/automatic-rest-apis.md).
+
+But you can [extend your tables with custom logic](../skills/extending-tables.md) and [create your own resources](../skills/custom-resources.md) in this directory.
+
+## Want to read more?
+
+Check out the rest of the "skills" documentation!
+
+[AGENTS.md](../AGENTS.md)

package/schemas/README.md

@@ -0,0 +1,11 @@
+# Schemas
+
+Your schemas are defined in `.graphql` files within this `schemas` directory. These files contain the structure and types for your database tables, allowing Harper to automatically generate REST APIs for CRUD operations.
+
+Take a look at the [Adding Tables with Schemas](../skills/adding-tables-with-schemas.md) to learn more!
+
+## Want to read more?
+
+Check out the rest of the "skills" documentation!
+
+[AGENTS.md](../AGENTS.md)

package/resources/examplePeople.ts

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

package/resources/exampleSocket.ts

@@ -1,41 +0,0 @@
-import { type IterableEventQueue, RequestTarget, Resource, tables } 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.ExamplePeople.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.ExamplePeople.get(id);
-					yield {
-						type: 'get',
-						id,
-						...(loaded ? loaded : {}),
-					};
-					break;
-				case 'put':
-					await tables.ExamplePeople.put(id, { name, tag });
-					break;
-			}
-		}
-	}
-}

package/resources/greeting.ts

@@ -1,29 +0,0 @@
-import { type RecordObject, type RequestTargetOrId, Resource } from 'harperdb';
-
-interface GreetingRecord {
-	greeting: string;
-}
-
-export class Greeting extends Resource<GreetingRecord> {
-	static loadAsInstance = false;
-
-	async post(target: RequestTargetOrId, newRecord: Partial<GreetingRecord & RecordObject>): Promise<GreetingRecord> {
-		return { greeting: 'Greetings, post!' };
-	}
-
-	async get(target?: RequestTargetOrId): Promise<GreetingRecord> {
-		return { greeting: 'Greetings, get!' };
-	}
-
-	async put(target: RequestTargetOrId, record: GreetingRecord & RecordObject): Promise<GreetingRecord> {
-		return { greeting: 'Greetings, put!' };
-	}
-
-	async patch(target: RequestTargetOrId, record: Partial<GreetingRecord & RecordObject>): Promise<GreetingRecord> {
-		return { greeting: 'Greetings, patch!' };
-	}
-
-	async delete(target: RequestTargetOrId): Promise<boolean> {
-		return true;
-	}
-}

package/schemas/examplePeople.graphql

@@ -1,7 +0,0 @@
-## 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 ExamplePeople @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
-}