@graffiti-garden/api 0.0.5 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graffiti-garden/api",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "The heart of Graffiti",
   "type": "module",
   "main": "src/index.ts",
@@ -29,12 +29,13 @@
   },
   "homepage": "https://api.graffiti.garden/classes/Graffiti.html",
   "devDependencies": {
-    "@types/json-schema": "^7.0.15",
-    "@types/node": "^22.10.5",
-    "ajv": "^8.17.1",
-    "fast-json-patch": "^3.1.1",
     "tslib": "^2.8.1",
     "typedoc": "^0.26.11",
     "vitest": "^2.1.8"
+  },
+  "dependencies": {
+    "@types/json-schema": "^7.0.15",
+    "ajv": "^8.17.1",
+    "fast-json-patch": "^3.1.1"
   }
 }

package/src/1-api.ts

@@ -333,7 +333,7 @@ export abstract class Graffiti {
   ): GraffitiStream<{
     channel: string;
     source: string;
-    lastModified: Date;
+    lastModified: string;
     count: number;
   }>;
 
@@ -358,10 +358,15 @@ export abstract class Graffiti {
   abstract listOrphans(session: GraffitiSession): GraffitiStream<{
     name: string;
     source: string;
-    lastModified: Date;
+    lastModified: string;
     tombstone: boolean;
   }>;
 
+  /**
+   * The age at which a query for a session will be considered expired.
+   */
+  abstract readonly maxAge: number;
+
   /**
    * Begins the login process. Depending on the implementation, this may
    * involve redirecting the user to a login page or opening a popup,

package/src/2-types.ts

@@ -95,12 +95,12 @@ export interface GraffitiObjectBase {
   source: string;
 
   /**
-   * The time the object was last modified. This is used for caching and synchronization.
+   * 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
    * 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: Date;
+  lastModified: string;
 
   /**
    * A boolean indicating whether the object has been deleted.

package/tests/crud.ts

@@ -41,9 +41,7 @@ export const graffitiCRUDTests = (
       expect(gotten.name).toEqual(previous.name);
       expect(gotten.actor).toEqual(previous.actor);
       expect(gotten.source).toEqual(previous.source);
-      expect(gotten.lastModified.getTime()).toEqual(
-        previous.lastModified.getTime(),
-      );
+      expect(gotten.lastModified).toEqual(previous.lastModified);
 
       // Replace it
       const newValue = {
@@ -58,24 +56,22 @@ export const graffitiCRUDTests = (
       expect(beforeReplaced.name).toEqual(previous.name);
       expect(beforeReplaced.actor).toEqual(previous.actor);
       expect(beforeReplaced.source).toEqual(previous.source);
-      expect(beforeReplaced.lastModified.getTime()).toBeGreaterThan(
-        gotten.lastModified.getTime(),
+      expect(new Date(beforeReplaced.lastModified).getTime()).toBeGreaterThan(
+        new Date(gotten.lastModified).getTime(),
       );
 
       // Get it again
       const afterReplaced = await graffiti.get(previous, {});
       expect(afterReplaced.value).toEqual(newValue);
-      expect(afterReplaced.lastModified.getTime()).toEqual(
-        beforeReplaced.lastModified.getTime(),
-      );
+      expect(afterReplaced.lastModified).toEqual(beforeReplaced.lastModified);
       expect(afterReplaced.tombstone).toEqual(false);
 
       // Delete it
       const beforeDeleted = await graffiti.delete(afterReplaced, session);
       expect(beforeDeleted.tombstone).toEqual(true);
       expect(beforeDeleted.value).toEqual(newValue);
-      expect(beforeDeleted.lastModified.getTime()).toBeGreaterThan(
-        beforeReplaced.lastModified.getTime(),
+      expect(new Date(beforeDeleted.lastModified).getTime()).toBeGreaterThan(
+        new Date(beforeReplaced.lastModified).getTime(),
       );
 
       // Try to get it and fail
@@ -286,9 +282,7 @@ export const graffitiCRUDTests = (
       expect(gotten.value).toEqual({
         something: "goodbye, world~ :c",
       });
-      expect(beforePatched.lastModified.getTime()).toBe(
-        gotten.lastModified.getTime(),
-      );
+      expect(beforePatched.lastModified).toBe(gotten.lastModified);
 
       await graffiti.delete(putted, session);
     });
@@ -475,9 +469,7 @@ export const graffitiCRUDTests = (
       expect(gotten.value).toEqual(object.value);
       expect(gotten.channels).toEqual(object.channels);
       expect(gotten.allowed).toEqual(object.allowed);
-      expect(gotten.lastModified.getTime()).toEqual(
-        putted.lastModified.getTime(),
-      );
+      expect(gotten.lastModified).toEqual(putted.lastModified);
     });
   });
 };

package/tests/synchronize.ts

@@ -28,9 +28,7 @@ export const graffitiSynchronizeTests = (
       expect(result.value.value).toEqual(object.value);
       expect(result.value.channels).toEqual(channels);
       expect(result.value.tombstone).toBe(false);
-      expect(result.value.lastModified.getTime()).toEqual(
-        gotten.lastModified.getTime(),
-      );
+      expect(result.value.lastModified).toEqual(gotten.lastModified);
     });
 
     it("put", async () => {
@@ -91,11 +89,11 @@ export const graffitiSynchronizeTests = (
       expect(sharedResult.value.value).toEqual(newValue);
       expect(sharedResult.value.channels).toEqual([sharedChannel]);
       expect(sharedResult.value.tombstone).toBe(false);
-      expect(beforeResult.value.lastModified.getTime()).toEqual(
-        afterResult.value.lastModified.getTime(),
+      expect(beforeResult.value.lastModified).toEqual(
+        afterResult.value.lastModified,
       );
-      expect(sharedResult.value.lastModified.getTime()).toEqual(
-        afterResult.value.lastModified.getTime(),
+      expect(sharedResult.value.lastModified).toEqual(
+        afterResult.value.lastModified,
       );
     });
 
@@ -172,11 +170,11 @@ export const graffitiSynchronizeTests = (
       expect(sharedResult.value.value).toEqual(newValue);
       expect(sharedResult.value.channels).toEqual([sharedChannel]);
       expect(sharedResult.value.tombstone).toBe(false);
-      expect(beforeResult.value.lastModified.getTime()).toEqual(
-        afterResult.value.lastModified.getTime(),
+      expect(beforeResult.value.lastModified).toEqual(
+        afterResult.value.lastModified,
       );
-      expect(sharedResult.value.lastModified.getTime()).toEqual(
-        afterResult.value.lastModified.getTime(),
+      expect(sharedResult.value.lastModified).toEqual(
+        afterResult.value.lastModified,
       );
     });