harperdb 4.1.2 → 4.2.0-alpha.6

package/README.md

@@ -21,10 +21,12 @@ Every Installation of HarperDB can be administered online using HarperDB Studio.
 
 [HarperDB Studio](https://studio.harperdb.io/sign-up)
 
-## Built-In API
-Reduce or eliminate complexity by using HarperDB’s built-in API. Create and manage not only the data you’re storing but all configuration and replication settings from a single endpoint that supports HTTP and HTTPS.
-- Reduce or Eliminate Middleware – speed up development and lower costs
-- Reduce Overhead, Increase Security – API requests are individually authenticated and self-closing
+### HarperDB APIs
+
+The preferred way to interact with HarperDB for typical querying, accessing, and updating data (CRUD) operations is through the REST interface, described in the REST documentation.
+
+The complete HarperDB Operations API documentation is available at api.harperdb.io, and provides important administrative functions. Generally it is recommended that use the RESTful interface as your primary interface for scalable and performant data interaction for building production applications, and the operations API for administrative purposes.
+
 
 [API Reference](https://api.harperdb.io/)
 ## Documentation and Support
@@ -59,4 +61,4 @@ HarperDB will prompt you for configuration options during install, and then auto
 
 ***
 
-e5e3ab0ecc460343724534f0e402cc237025113b
+e6defe9ab4b645cab1ced61c464f3d6e452e2788

package/{custom_function_template → application-template}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 HarperDB, Inc.
+Copyright (c) 2023 HarperDB, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/application-template/README.md

@@ -0,0 +1,15 @@
+# HarperDB Application Template
+
+This is a template for building [HarperDB](https://www.harperdb.io/) applications. You can download this repository as a starting point for building applications with HarperDB. To get started, make sure you have [installed HarperDB](https://docs.harperdb.io/docs/install-harperdb), which can be quickly done with `npm install -g harperdb`. You can run your application from the directory where you downloaded the contents of this repository with:
+
+`harperdb run /path/to/your-app`
+
+(or if you enter that directory, you can run the current directory as `harperdb run .`).
+
+For more information about getting started with HarperDB and building applications, see our getting started guide.
+
+This template includes the [default configuration](./config.yaml), which specifies how files are handled in your application.
+
+The [schema.graphql](./schema.graphql) is the 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.

package/application-template/config.yaml

@@ -0,0 +1,18 @@
+# This defines the configuration of this application. Each defines a (sub) component that is loaded and
+# used for this application. These components can provide specific functionality and define how different
+# files in your app are loaded.
+REST: true  # These provides the HTTP REST interface for all exported resources
+graphqlSchema:  # These reads GraphQL schemas to define the schema of database/tables/attributes.
+  files: '*.graphql' # looks for these files
+  # path: / # exported queries are on the root path by default
+jsResource: # Loads JavaScript modules such that their exports are exported as resources
+  files: resources.js # the entry module for resources
+  # path: / # exported resources are on the root path by default, like http://server/resource-name
+fastifyRoutes: # This loads files that define fastify routes using fastify's auto-loader
+  files: routes/*.js
+  path: . # relative to the app-name, like  http://server/app-name/route-name
+static: # This allows static files to be directly accessible
+  root: web
+  files: web/**
+  # login
+  #path: /

package/application-template/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "application-template",
+  "version": "1.0.0",
+  "description": "A template for building HarperDB applications",
+  "type": "module"
+}

package/application-template/resources.js

@@ -0,0 +1,22 @@
+/** Here we can define any JavaScript-based resources and extensions to tables
+
+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
+	get() {
+		return { greeting: 'Hello, world!' };
+	}
+}

package/application-template/schema.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 TableName @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
+}