merged with master

Author: Keyology

resources.js

@@ -89,53 +89,54 @@ export class ExamplePageCache extends PageCache {
 
 /********************************************************************************************************** */
 
+/*
 
-// A class used to update the cache for a specific page
-// export class PageCacheResource extends PageCache {
+A class used to update the cache for a specific page
+export class PageCacheResource extends PageCache {
 
-// 	// Invalidate the cache if necessary
-// 	invalidate() {
-// 	  super.invalidate();
-// 	}
+	// Invalidate the cache if necessary
+	invalidate() {
+	  super.invalidate();
+	}
   
-// 	// Fetch the page and update the cache
-// 	async get() {
-// 	  try {
-// 		const pageURL = ``; // URL of the page to cache
-// 		const cacheId = `pageURL/ + ${this.getId()}`; // Get the ID of the page to cache (to be implemented by the user)
+	// Fetch the page and update the cache
+	async get() {
+	  try {
+		const pageURL = ``; // URL of the page to cache
+		const cacheId = `pageURL/ + ${this.getId()}`; // Get the ID of the page to cache (to be implemented by the user)
   
-// 		// Fetch the page content
-// 		const response = await fetch(pageURL);
+		// Fetch the page content
+		const response = await fetch(pageURL);
 		
-// 		if (!response.ok) {
-// 		  throw new Error(`Failed to fetch the page: ${response.status}`);
-// 		}
+		if (!response.ok) {
+		  throw new Error(`Failed to fetch the page: ${response.status}`);
+		}
   
-// 		// Convert the HTML content to string
-// 		const htmlContent = await response.text();
+		// Convert the HTML content to string
+		const htmlContent = await response.text();
   
-// 		// Return the cached data in a structured format
-// 		return { id: cacheId, cachedData: htmlContent };
+		// Return the cached data in a structured format
+		return { id: cacheId, cachedData: htmlContent };
 		
-// 	  } catch (e) {
-// 		console.log("CACHING ERROR:", e);
-// 	  }
-// 	}
-//   }
+	  } catch (e) {
+		console.log("CACHING ERROR:", e);
+	  }
+	}
+  }
   
   // Define PageCacheResource as the cache source
-  //PageCache.sourcedFrom(PageCacheResource);
+  PageCache.sourcedFrom(PageCacheResource);
+  */
 
   /*
 	  Usage Instructions:
   
-	  1. Implement the `getId()` method to define how cache IDs are generated.
+	  1. define the cache IDs.
 	  2. Customize `pageURL` based on where the page is hosted.
 	  3. Call this URL to access the cached content:
 		 http://localhost:9926/PageCacheResource/{yourCacheId}
   
 	  Example: 
-	  - Define your own logic for `getId()` to uniquely identify pages.
 	  - The returned `cachedData` will contain the HTML as a string.
   */
 
@@ -177,56 +178,3 @@ PageCache.sourcedFrom(PageCacheResource);
 //http://localhost:9926/PageCache/<cacheId>
 
 
-
-
-// TODO: need to create a README.md file with instructions on how to implement partial page caching
-
-
-
-// TODO: EXTRA
-
-
-
-
-
-//export class PageCache extends tables.PageCache {
-// 	get() {
-// 		return this.html;
-//    }
-
-
-// export class PageCache extends tables.PageCache {
-// 	get() {
-// 	  return { // can also return a full response header
-// 		 status: 200,
-// 		 headers: { 'Content-Type': 'text/html' },
-// 		 body: this.html
-// 		}
-// 	  }
-// 	}
-
-
-
-// http://host.com/PageCache/testPage.html
-
-
-
-// Put some thought into 
-
-// Naming component based on the the functionality of the component
-
-
-// fumctionality intent behind each component 
-
-// extenstion
-
-
-// TODO: 
-
-// What distinguishes each component from the other 
-
-
-// intent of use vs functionality of a component
-
-
-

schema.graphql

@@ -5,10 +5,17 @@
 
 # This will be the table where users can store their pages they would like to cache
 # Keep this table simple
-type PageCache @table(expiration: 3600) @export{
-    cacheControl: String # save cache control headers
-    id: ID @primaryKey # Note ID should path to webpage url you are caching (e.g  in https://www.birkenstock.com/us/men/ the id should be /us/men/ ) This is our primary key Key
-    cachedData: String # cachedData should be the html of the webpage you are caching stored as a string
+type PageCache @table(expiration: 3600) @export {
+    cacheControl: String 
+    # Stores the Cache-Control headers for the page, which dictate how caching should be handled (e.g., max-age, no-cache).
 
+    id: ID @primaryKey 
+    # The primary key representing the URL path of the cached webpage.
+    # Example: For the URL https://www.birkenstock.com/us/men/, the `id` should be "/us/men/".
+    # This allows us to uniquely identify cached pages based on their path.
+
+    cachedData: String 
+    # Stores the full HTML of the cached webpage as a string.
+    # This is the rendered content that will be served from cache on subsequent requests.
 }