@graffiti-garden/api 0.0.7 → 0.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graffiti-garden/api",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "The heart of Graffiti",
   "type": "module",
   "main": "src/index.ts",

package/src/1-api.ts

@@ -19,13 +19,17 @@ import type { JSONSchema4 } from "json-schema";
  * user interface tools to present and interact with the data.
  *
  * There are several different implementations of this Graffiti API available,
- * including a decentralized implementation and a local implementation
+ * including a [decentralized implementation](https://github.com/graffiti-garden/client-core),
+ * and a [local implementation](https://github.com/graffiti-garden/implementation-pouchdb)
  * that can be used for testing. In the design of Graffiti we prioritized
  * the design of this API first as it is the layer that shapes the experience
  * of developing applications. While different implementations provide tradeoffs between
  * other important properties (e.g. privacy, security, scalability), those properties
  * are useless if the system as a whole is unusable. Build APIs before protocols!
  *
+ * There is also a wrapper around this API that provides a [Vue plugin](https://github.com/graffiti-garden/wrapper-vue/)
+ * that enables reactivity. Other front-end frameworks can be supported in the future.
+ *
  * The first group of methods are like standard CRUD methods that
  * allow applications to {@link put}, {@link get}, {@link patch}, and {@link delete}
  * {@link GraffitiObjectBase} objects. The main difference between these
@@ -333,7 +337,7 @@ export abstract class Graffiti {
   ): GraffitiStream<{
     channel: string;
     source: string;
-    lastModified: string;
+    lastModified: number;
     count: number;
   }>;
 
@@ -365,7 +369,7 @@ export abstract class Graffiti {
   /**
    * The age at which a query for a session will be considered expired.
    */
-  abstract readonly maxAge: number;
+  // abstract readonly maxAge: number;
 
   /**
    * Begins the login process. Depending on the implementation, this may

package/src/2-types.ts

@@ -95,12 +95,16 @@ export interface GraffitiObjectBase {
   source: string;
 
   /**
-   * The time the object was last modified in [ISO format](https://fits.gsfc.nasa.gov/iso-time.html). This is used for caching and synchronization.
-   * It can also be used to sort objects in a user interface but in many cases it would be better to
+   * The time the object was last modified, measured in milliseconds since January 1, 1970.
+   * This is used for caching and synchronization.
+   * A number, rather than an ISO string or Date object, is used for easy comparison, sorting,
+   * and JSON Schema [range queries](https://json-schema.org/understanding-json-schema/reference/numeric#range).
+   *
+   * It is possible to use this value to sort objects in a user's interface but in many cases it would be better to
    * use a `createdAt` property in the object's {@link value | `value`} to indicate when the object was created
    * rather than when it was modified.
    */
-  lastModified: string;
+  lastModified: number;
 
   /**
    * A boolean indicating whether the object has been deleted.

package/tests/crud.ts

@@ -56,9 +56,7 @@ export const graffitiCRUDTests = (
       expect(beforeReplaced.name).toEqual(previous.name);
       expect(beforeReplaced.actor).toEqual(previous.actor);
       expect(beforeReplaced.source).toEqual(previous.source);
-      expect(new Date(beforeReplaced.lastModified).getTime()).toBeGreaterThan(
-        new Date(gotten.lastModified).getTime(),
-      );
+      expect(beforeReplaced.lastModified).toBeGreaterThan(gotten.lastModified);
 
       // Get it again
       const afterReplaced = await graffiti.get(previous, {});
@@ -70,8 +68,8 @@ export const graffitiCRUDTests = (
       const beforeDeleted = await graffiti.delete(afterReplaced, session);
       expect(beforeDeleted.tombstone).toEqual(true);
       expect(beforeDeleted.value).toEqual(newValue);
-      expect(new Date(beforeDeleted.lastModified).getTime()).toBeGreaterThan(
-        new Date(beforeReplaced.lastModified).getTime(),
+      expect(beforeDeleted.lastModified).toBeGreaterThan(
+        beforeReplaced.lastModified,
       );
 
       // Try to get it and fail