@sitecore-feaas/clientside 0.5.4 → 0.5.6

package/test/FEAASStylesheet.test.tsx

@@ -29,7 +29,7 @@ describe('Stylesheet', () => {
   it('should load stylesheet (cold cache)', async () => {
     const spy = vi.spyOn(global, 'fetch')
     spy.mockImplementation(async (url: string, options: Parameters<typeof fetch>[1] = {}) => {
-      return new Response('TODAY {}', {
+      return new Response('FRESH {}', {
         headers: {
           date: now.toUTCString(),
           'last-modified': earlier.toUTCString()
@@ -44,13 +44,13 @@ describe('Stylesheet', () => {
     await expect(stylesheet.whenRendered).resolves.toEqual(stylesheet)
     expect(spy).toHaveBeenCalledTimes(1)
 
-    expect(document.head.querySelector('style').textContent).toContain('TODAY')
+    expect(document.head.querySelector('style').textContent).toContain('FRESH')
   })
   it('should load stylesheet with minimum parameters(cold cache)', async () => {
     const spy = vi.spyOn(global, 'fetch')
     spy.mockImplementation(async (url: string, options: Parameters<typeof fetch>[1] = {}) => {
       if (url.match(DEFAULT_CDN_URL + '/styles/L/published.css'))
-        return new Response('TODAY {}', {
+        return new Response('FRESH {}', {
           headers: {
             date: now.toUTCString(),
             'last-modified': earlier.toUTCString()
@@ -65,14 +65,14 @@ describe('Stylesheet', () => {
     await expect(stylesheet.whenRendered).resolves.toEqual(stylesheet)
     expect(spy).toHaveBeenCalledTimes(1)
 
-    expect(document.head.querySelector('style').textContent).toContain('TODAY')
+    expect(document.head.querySelector('style').textContent).toContain('FRESH')
   })
 
   it('should invalidate stylesheet cache', async () => {
     const spy = vi.spyOn(global, 'fetch')
     spy.mockImplementation(async (url: string, options: Parameters<typeof fetch>[1] = {}) => {
       if (url.match('CDN/styles/L/published.css') && options?.method != 'HEAD') {
-        return new Response('TODAY {}', {
+        return new Response('FRESH {}', {
           headers: {
             date: earlier.toUTCString(),
             'last-modified': earlier.toUTCString()
@@ -95,7 +95,7 @@ describe('Stylesheet', () => {
     await expect(stylesheet.whenRendered).resolves.toEqual(stylesheet)
     expect(spy).toHaveBeenCalledTimes(2)
 
-    expect(document.head.querySelector('style').textContent).toContain('TODAY')
+    expect(document.head.querySelector('style').textContent).toContain('FRESH')
   })
   it('should update stylesheet while using stale cache', async () => {
     const spy = vi.spyOn(global, 'fetch')
@@ -117,7 +117,7 @@ describe('Stylesheet', () => {
           }
         })
       } else {
-        return new Response('TODAY {}', {
+        return new Response('FRESH {}', {
           headers: {
             date: now.toUTCString(),
             'last-modified': earlier.toUTCString()
@@ -137,7 +137,7 @@ describe('Stylesheet', () => {
     // whenLoaded only fires when ensures that up-to-date version is loaded
     await expect(stylesheet.whenLoaded).resolves.toBeTruthy()
     expect(spy).toHaveBeenCalledTimes(3)
-    expect(document.head.querySelector('style').textContent).toContain('TODAY {}')
+    expect(document.head.querySelector('style').textContent).toContain('FRESH {}')
   })
 
   it('should load stylesheet statically', async () => {
@@ -160,7 +160,7 @@ describe('Stylesheet', () => {
           }
         })
       } else {
-        return new Response('TODAY {}', {
+        return new Response('FRESH {}', {
           headers: {
             date: now.toUTCString(),
             'last-modified': earlier.toUTCString()
@@ -175,7 +175,9 @@ describe('Stylesheet', () => {
         library: 'L',
         revision: 'published'
       }).then((r) => r.textContent)
-    ).resolves.toEqual('TODAY {}')
-    await expect(loadStylesheet(`http://CDN/L/published.css`).then((r) => r.textContent)).resolves.toEqual('TODAY {}')
+    ).resolves.toEqual('FRESH {}')
+    await expect(loadStylesheet(`http://CDN/L/published.css`).then((r) => r.textContent)).resolves.toEqual('FRESH {}')
   })
+
+  it('should ')
 })

package/test/datasettings.test.ts

@@ -118,6 +118,98 @@ describe('DataSettings', () => {
       ])
     })
   })
+  describe('.isDataSettings', () => {
+    it('should return true if data has all the required properties', () => {
+      const data = {
+        url: 'https://example.com',
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' }
+      }
+
+      expect(DataSettings.isDataSettings(data)).toBe(true)
+    })
+
+    it('should return false if data does not have the "url" property', () => {
+      const data = {
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' }
+      }
+
+      expect(DataSettings.isDataSettings(data)).toBe(false)
+    })
+
+    it('should return false if data has an additional property apart from the allowed ones', () => {
+      const data = {
+        url: 'https://example.com',
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' },
+        invalidProperty: 'invalid'
+      }
+
+      expect(DataSettings.isDataSettings(data)).toBe(false)
+    })
+
+    it('should return false if "jsonpath" property is not a string', () => {
+      const data = {
+        url: 'https://example.com',
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' },
+        jsonpath: { invalid: 'value' }
+      }
+
+      expect(DataSettings.isDataSettings(data)).toBe(false)
+    })
+  })
+  describe('.hasDataSettings', () => {
+    it('should return false if data is falsy', () => {
+      expect(DataSettings.hasDataSettings(null)).toBe(false)
+      expect(DataSettings.hasDataSettings(undefined)).toBe(false)
+      expect(DataSettings.hasDataSettings({ test: null })).toBe(false)
+      expect(DataSettings.hasDataSettings({ test: undefined })).toBe(false)
+    })
+    it('should return true for simple case', () => {
+      expect(DataSettings.hasDataSettings({ test: { url: 'a' } })).toBe(true)
+      expect(DataSettings.hasDataSettings({ url: 'a' })).toBe(true)
+    })
+
+    it('should return true if data has a valid DataSettings object', () => {
+      const data = {
+        url: 'https://example.com',
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' }
+      }
+
+      expect(DataSettings.hasDataSettings(data)).toBe(true)
+      expect(DataSettings.hasDataSettings({ a: data })).toBe(true)
+    })
+
+    it('should return true if any property in data is a valid DataSettings object', () => {
+      const data = {
+        url: 'https://example.com',
+        method: 'GET',
+        headers: { 'Content-Type': 'application/json' },
+        nestedData: {
+          url: 'https://example.com/nested',
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json' }
+        }
+      }
+
+      expect(DataSettings.hasDataSettings(data)).toBe(true)
+    })
+
+    it('should return false if all properties in data are invalid', () => {
+      const data = {
+        property1: 'value1',
+        property2: { invalid: 'object' },
+        property3: false
+      }
+
+      expect(DataSettings.hasDataSettings(data)).toBe(false)
+    })
+
+    // Add more test cases to cover other scenarios
+  })
   describe('.fetch', () => {
     it('fetches when passed data object', async () => {
       const result = await DataSettings.fetch({ hello: 'world' })

package/types/dom/rendering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rendering.d.ts","sourceRoot":"","sources":["../../src/dom/rendering.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAElD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAIvD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAG5C,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,MAAM,CAAA;IACtF,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,KAAK,GAAG,CAAA;IAC7D,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IAC1E,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAA;IAC5D,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAA;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG;IAC7E,IAAI,CAAC,EAAE,CAAC,CAAA;CACT,GAAG,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,GAC7C,mBAAmB,CAAA;AAsDrB,wBAAgB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,mBAAmB,QAwFhH;AAID,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,WAAW,GAAG,gBAAgB,EACrC,UAAU,CAAC,EAAE,GAAG,EAChB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,QAAQ,CAAC,EAAE,OAAO,eA0CnB;AAMD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,mBAAmB,eAc9G;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,mBAAmB,EAAE,OAAO,UAAQ,UAW7G"}
+{"version":3,"file":"rendering.d.ts","sourceRoot":"","sources":["../../src/dom/rendering.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAElD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAIvD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAG5C,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,MAAM,CAAA;IACtF,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,KAAK,GAAG,CAAA;IAC7D,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IAC1E,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAA;IAC5D,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAA;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG;IAC7E,IAAI,CAAC,EAAE,CAAC,CAAA;CACT,GAAG,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,GAC7C,mBAAmB,CAAA;AAsDrB,wBAAgB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,mBAAmB,QAkGhH;AAID,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,WAAW,GAAG,gBAAgB,EACrC,UAAU,CAAC,EAAE,GAAG,EAChB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,QAAQ,CAAC,EAAE,OAAO,eA+CnB;AAMD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,mBAAmB,eAc9G;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,mBAAmB,EAAE,OAAO,UAAQ,UAW7G"}

package/types/dom/stylesheet.d.ts

@@ -3,6 +3,6 @@ export declare function renderStylesheet(props: FEAASCDNStylesheetProps, style?:
 export declare function renderStylesheetPromise(props: FEAASCDNStylesheetProps, stylesheet?: HTMLStyleElement): Promise<HTMLStyleElement>;
 export declare function loadStylesheet(props: FEAASCDNStylesheetProps, callback?: ValidatableStylesheetCallback): Promise<HTMLStyleElement>;
 export declare function loadStylesheetAllowStale(props: FEAASCDNStylesheetProps): Promise<unknown>;
-export declare function findStylesheet(props: FEAASCDNStylesheetProps): Element;
+export declare function findStylesheet(props: FEAASCDNStylesheetProps): HTMLLinkElement | HTMLStyleElement;
 export declare function createStylesheet(props: FEAASCDNStylesheetProps): HTMLStyleElement;
 //# sourceMappingURL=stylesheet.d.ts.map

package/types/dom/stylesheet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stylesheet.d.ts","sourceRoot":"","sources":["../../src/dom/stylesheet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EAGvB,6BAA6B,EAC9B,MAAM,WAAW,CAAA;AAElB,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,uBAAuB,EAAE,KAAK,CAAC,EAAE,gBAAgB,oBAGxF;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,uBAAuB,EAAE,UAAU,CAAC,EAAE,gBAAgB,6BAKpG;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,CAAC,EAAE,6BAA6B,6BAiBtG;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,uBAAuB,oBAItE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,uBAAuB,WAK5D;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,uBAAuB,oBAM9D"}
+{"version":3,"file":"stylesheet.d.ts","sourceRoot":"","sources":["../../src/dom/stylesheet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EAGvB,6BAA6B,EAC9B,MAAM,WAAW,CAAA;AAElB,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,uBAAuB,EAAE,KAAK,CAAC,EAAE,gBAAgB,oBAGxF;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,uBAAuB,EAAE,UAAU,CAAC,EAAE,gBAAgB,6BAKpG;AAGD,wBAAgB,cAAc,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,CAAC,EAAE,6BAA6B,6BAkBtG;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,uBAAuB,oBAItE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,uBAAuB,sCAK5D;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,uBAAuB,oBAM9D"}

package/types/dom/thumbnail.d.ts

@@ -1,5 +1,5 @@
 import type { VersionModel, ComponentModel, StylesheetModel } from '@sitecore-feaas/sdk';
-export type Callback = (image: HTMLImageElement, isCached: boolean) => void;
+export type Callback = (image: HTMLImageElement | null, isCached: boolean) => void;
 export declare const convertBase64toBlob: (base64: string) => Promise<Blob>;
 /** Parse fetch response as blob and turn it into HTMLImageElement off thread */
 export declare const responseToImage: (response: Response) => Promise<HTMLImageElement>;

package/types/dom/thumbnail.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"thumbnail.d.ts","sourceRoot":"","sources":["../../src/dom/thumbnail.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAIpG,MAAM,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAA;AAE3E,eAAO,MAAM,mBAAmB,WAAY,MAAM,kBAA4C,CAAA;AAE9F,gFAAgF;AAChF,eAAO,MAAM,eAAe,aAAc,QAAQ,KAAG,QAAQ,gBAAgB,CAUzE,CAAA;AAEJ;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAG7F;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,6BAqB/F;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,IAAI,CACxB,SAAS,EAAE,cAAc,EACzB,OAAO,CAAC,EAAE,YAAY,EACtB,QAAQ,CAAC,EAAE,QAAQ,GAClB,OAAO,CAAC,gBAAgB,CAAC,CAmC3B;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,gBAAgB,CAAC,EAAE,eAAe,6BAsBnH;AAuFD;;;;;;;;;;;GAWG;AACH,wBAAsB,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CA+B1G"}
+{"version":3,"file":"thumbnail.d.ts","sourceRoot":"","sources":["../../src/dom/thumbnail.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAIpG,MAAM,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAA;AAElF,eAAO,MAAM,mBAAmB,WAAY,MAAM,kBAA4C,CAAA;AAE9F,gFAAgF;AAChF,eAAO,MAAM,eAAe,aAAc,QAAQ,KAAG,QAAQ,gBAAgB,CAUzE,CAAA;AAEJ;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAG7F;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,6BAqB/F;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,IAAI,CACxB,SAAS,EAAE,cAAc,EACzB,OAAO,CAAC,EAAE,YAAY,EACtB,QAAQ,CAAC,EAAE,QAAQ,GAClB,OAAO,CAAC,gBAAgB,CAAC,CAmC3B;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,gBAAgB,CAAC,EAAE,eAAe,6BAsBnH;AAuFD;;;;;;;;;;;GAWG;AACH,wBAAsB,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CA+B1G"}

package/types/fetch.d.ts

@@ -1,16 +1,4 @@
 import { ControlledPromise } from './utils/promise.js';
-/**
- * Utility to cache-bust static files. It relies on reading Date header to detect cached response, so it requires CORS
- * settings to be set.
- *
- * It accepts validator function that determines if response is usable. If response was pulled from cache and is valid,
- * the optional callback function is fired right away. Then HEAD request is made bypassing the cache, to see if the
- * response has an newer Last-Modified header. In case it does and it passes validation, third request is fired that
- * actually fetches the new content and callback is invoked the second time.
- *
- * It works as promise, but also accepts callback to use cached blobs mid-flight and have access to headers. Any network
- * errors will not be caught. Function throws when unable to fetch valid response.
- */
 declare const phases: readonly ["initial", "check", "updated"];
 export type ValidatableRequestPhase = (typeof phases)[number];
 export type FetchCache = Record<string, FetchCacheRequest>;
@@ -32,10 +20,35 @@ export type FetchCacheRequest = {
 };
 export declare var fetchCache: Record<string, FetchCacheRequest>;
 export declare function clearFetchCache(): void;
+/**
+ * Utility to cache-bust static files. It relies on reading Date header to detect cached response, so it requires CORS
+ * settings to be set.
+ *
+ * It accepts validator function that determines if response is usable. If response was pulled from cache and is valid,
+ * the optional callback function is fired right away. Then HEAD request is made bypassing the cache, to see if the
+ * response has an newer Last-Modified header. In case it does and it passes validation, third request is fired that
+ * actually fetches the new content and callback is invoked the second time.
+ *
+ * It works as promise, but also accepts callback to use cached blobs mid-flight and have access to headers. Any network
+ * errors will not be caught. Function throws when unable to fetch valid response.
+ */
 export declare function fetchAndRevalidate(url: ValidatableRequest['url'], options?: ValidatableRequest['options'], validator?: ValidatableRequest['validator'], callback?: ValidatableRequest['callback'], cache?: FetchCache): Promise<Response>;
-export declare function getFetchCache(url: Parameters<typeof fetch>[0], dontCreate?: boolean): FetchCacheRequest;
-export declare class InvalidResponse extends Error {
-}
+/**
+ * Executes a fetch request optionally validating and handling the response. Using callback function it's possible to
+ * observe successful response twice: Cached version first, and up-to-date later.
+ *
+ * @param {Object}                  request              - An object containing request parameters.
+ * @param {string}                  request.url          - The URL to fetch.
+ * @param {Object}                  request.options      - Fetch request options.
+ * @param {Function}                [request.validator]  - Function to validate the response. Should return `false` if
+ *                                                       validation fails.
+ * @param {Function}                [request.callback]   - Function to execute after fetching. Receives the response,
+ *                                                       phase, and cache status.
+ * @param {Object}                  [request.cache]      - Cache object to store or retrieve cached data.
+ * @param {ValidatableRequestPhase} [phase='initial']    - The phase of the request, defaults to 'initial'.
+ * @returns {Promise<Object>} A promise that resolves to an object containing request details and the response.
+ * @throws {Error} Throws an error if the fetch fails or if the response is not valid according to the validator.
+ */
 export declare function fetchWithCacheAwareness({ url, options, validator, callback, cache }: ValidatableRequest, phase?: ValidatableRequestPhase): Promise<{
     url: RequestInfo | URL;
     options: RequestInit;
@@ -45,6 +58,17 @@ export declare function fetchWithCacheAwareness({ url, options, validator, callb
     callback: (response: Response, status: "initial" | "check" | "updated", isCached: boolean) => any;
     cache: FetchCache;
 }>;
+export declare function getFetchCache(url: Parameters<typeof fetch>[0], dontCreate?: boolean): FetchCacheRequest;
+export declare class InvalidResponse extends Error {
+}
+/**
+ * Validates cache of previousl fetch If the resource is cached and there is a newer version available, it will be
+ * re-fetched.
+ *
+ * @param request  - The request object containing the URL, cache information, options, validator, and response of
+ *                 initial request.
+ * @returns A promise that resolves to the request object.
+ */
 export declare function fetchToValidateCache(request: ValidatableRequest & Required<Pick<ValidatableRequest, 'response'>>): Promise<ValidatableRequest & Required<Pick<ValidatableRequest, "response">>>;
 export declare function fetchBypassingCache(request: ValidatableRequest): Promise<{
     url: RequestInfo | URL;

package/types/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAEtD;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,MAAM,0CAA2C,CAAA;AACvD,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAA;AAC7D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAC1D,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACrC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IAC9D,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,uBAAuB,EAAE,QAAQ,EAAE,OAAO,KAAK,GAAG,CAAA;IAC1F,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,KAAK,CAAC,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,uBAAuB,CAAA;IAC9B,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IACpC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAClC,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IACpC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;CACnC,CAAA;AAED,eAAO,IAAI,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAM,CAAA;AAC7D,wBAAgB,eAAe,SAE9B;AAED,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,EAC9B,OAAO,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,EACvC,SAAS,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC,EAC3C,QAAQ,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,EACzC,KAAK,GAAE,UAAuB,qBAM/B;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,UAAQ,qBAajF;AAED,qBAAa,eAAgB,SAAQ,KAAK;CAAG;AAE7C,wBAAsB,uBAAuB,CAC3C,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAChE,KAAK,GAAE,uBAAmC;;;;;;;;GAmC3C;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC,gFA0B7E;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB;;;;;;;;GAWpE"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAEtD,QAAA,MAAM,MAAM,0CAA2C,CAAA;AACvD,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAA;AAC7D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAC1D,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACrC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAA;IAC9D,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,uBAAuB,EAAE,QAAQ,EAAE,OAAO,KAAK,GAAG,CAAA;IAC1F,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,KAAK,CAAC,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,uBAAuB,CAAA;IAC9B,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IACpC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAClC,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IACpC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;CACnC,CAAA;AAED,eAAO,IAAI,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAM,CAAA;AAC7D,wBAAgB,eAAe,SAE9B;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,EAC9B,OAAO,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,EACvC,SAAS,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC,EAC3C,QAAQ,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,EACzC,KAAK,GAAE,UAAuB,qBAM/B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,uBAAuB,CAC3C,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAChE,KAAK,GAAE,uBAAmC;;;;;;;;GAmC3C;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,UAAQ,qBAajF;AAED,qBAAa,eAAgB,SAAQ,KAAK;CAAG;AAE7C;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC,gFA0B7E;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB;;;;;;;;GAWpE"}

package/types/utils/data.d.ts

@@ -1,7 +1,7 @@
 import { JSONPath } from 'jsonpath-plus';
 export declare function queryObjectRaw(json: any, path: string): any[];
-export declare function queryObject(json: any, path: string): any[];
-export declare function queryScopes(scopes: any, datapath: string, singleValue?: boolean, json?: any): any;
+export declare function queryObject(json: any, path: string, flatten?: boolean): any[];
+export declare function queryScopes(scopes: any, datapath: string, singleValue?: boolean, json?: any, flatten?: boolean): any;
 export type CH1Node = {
     type: string;
     text?: string;

package/types/utils/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../src/utils/data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,wBAAgB,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,SAMrD;AACD,wBAAgB,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,SAElD;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,UAAQ,EAAE,IAAI,GAAE,GAAY,OAsDjG;AAED,MAAM,MAAM,OAAO,GACf;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,GACD,OAAO,EAAE,CAAA;AAQb,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAqCtF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../src/utils/data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,wBAAgB,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,SAMrD;AACD,wBAAgB,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,UAAO,SAMlE;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,UAAQ,EAAE,IAAI,GAAE,GAAY,EAAE,OAAO,UAAO,OAsDjH;AAED,MAAM,MAAM,OAAO,GACf;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,GACD,OAAO,EAAE,CAAA;AAQb,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAqCtF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/types/utils/settings.d.ts

@@ -15,7 +15,7 @@ export declare function clean(settings: any): Partial<{
     params: Record<string, any>;
     headers: Record<string, string>;
     jsonpath: string;
-    method: "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE" | "HEAD";
+    method: "HEAD" | "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE";
     body: Record<string, any>;
     url: string;
 }>;
@@ -29,7 +29,7 @@ export declare const isDataSettings: (data: any) => data is {
     params: Record<string, any>;
     headers: Record<string, string>;
     jsonpath: string;
-    method: "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE" | "HEAD";
+    method: "HEAD" | "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE";
     body: Record<string, any>;
     url: string;
 };
@@ -51,7 +51,7 @@ export declare function DataSettings(settings: any): {
     params: Record<string, any>;
     headers: Record<string, string>;
     jsonpath: string;
-    method: "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE" | "HEAD";
+    method: "HEAD" | "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE";
     body: Record<string, any>;
     url: string;
 };
@@ -62,7 +62,7 @@ export declare namespace DataSettings {
         params: Record<string, any>;
         headers: Record<string, string>;
         jsonpath: string;
-        method: "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE" | "HEAD";
+        method: "HEAD" | "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE";
         body: Record<string, any>;
         url: string;
     }) => Promise<Data>;
@@ -71,7 +71,7 @@ export declare namespace DataSettings {
         params: Record<string, any>;
         headers: Record<string, string>;
         jsonpath: string;
-        method: "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE" | "HEAD";
+        method: "HEAD" | "GET" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "UPDATE";
         body: Record<string, any>;
         url: string;
     };