@adobe/exc-app 1.0.4 → 1.0.7

package/docs/interfaces/network.querydefinition.md

@@ -0,0 +1,100 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [network](../modules/network.md) / QueryDefinition
+
+# Interface: QueryDefinition
+
+Defines a GraphQL query that will be executed to fetch the data exposed by this contract.
+
+## Hierarchy
+
+* [GraphQLQuery](network.graphqlquery.md)
+
+  ↳ **QueryDefinition**
+
+## Index
+
+### Properties
+
+* [dataPath](network.querydefinition.md#datapath)
+* [fetchScope](network.querydefinition.md#fetchscope)
+* [ignoreErrorsOnPaths](network.querydefinition.md#ignoreerrorsonpaths)
+* [query](network.querydefinition.md#query)
+* [variables](network.querydefinition.md#variables)
+
+## Properties
+
+### dataPath
+
+• `Optional` **dataPath**: undefined \| string
+
+When provided, the data at the certain path will be returned.
+If not provided, the entire GraphQL response will be returned.
+
+___
+
+### fetchScope
+
+•  **fetchScope**: [FetchScope](../enums/network.fetchscope.md)
+
+Fetch scope. Controls which headers are sent with the query.
+See fetch documentation for more info.
+
+___
+
+### ignoreErrorsOnPaths
+
+• `Optional` **ignoreErrorsOnPaths**: string[]
+
+Do not fail (throw) when encountering errors while processing the query if the errors
+happened on certain paths.
+
+___
+
+### query
+
+•  **query**: string
+
+*Inherited from [GraphQLQuery](network.graphqlquery.md).[query](network.graphqlquery.md#query)*
+
+GQL Query.
+
+***Example:***
+
+```typescript
+{query: `
+  query userBehanceQuery($userId: String!, $apiKey: String!) {
+    userBehance(userId: $userId, apiKey: $apiKey) {
+      images
+    }
+  }`
+};
+
+{query: `
+  query userBehanceQuery {
+    userBehance(userId: "123@AdobeID", apiKey: "test-app") {
+      images
+    }
+  }`
+};
+```
+
+___
+
+### variables
+
+• `Optional` **variables**: Record<string, any\>
+
+*Inherited from [GraphQLQuery](network.graphqlquery.md).[variables](network.graphqlquery.md#variables)*
+
+Query specific variables- key value pairs.
+
+***Example:***
+
+```typescript
+{variables: {
+  apiKey: 'test-app',
+  userId: '123@AdobeID'
+ }
+};
+```

package/docs/interfaces/root.runtimeconfiguration.md

@@ -21,6 +21,7 @@ External Runtime Configuration Interface
 * [baseFrameUrl](root.runtimeconfiguration.md#baseframeurl)
 * [basePath](root.runtimeconfiguration.md#basepath)
 * [baseUrl](root.runtimeconfiguration.md#baseurl)
+* [cdn](root.runtimeconfiguration.md#cdn)
 * [changedProperties](root.runtimeconfiguration.md#changedproperties)
 * [discovery](root.runtimeconfiguration.md#discovery)
 * [environment](root.runtimeconfiguration.md#environment)
@@ -117,6 +118,14 @@ Base URL
 
 ___
 
+### cdn
+
+•  **cdn**: string
+
+Environment specific CDN string.
+
+___
+
 ### changedProperties
 
 •  **changedProperties**: keyof [RuntimeConfiguration](root.runtimeconfiguration.md)[]

package/docs/interfaces/shell.shellinfo.md

@@ -12,12 +12,19 @@
 
 ### Properties
 
+* [cdn](shell.shellinfo.md#cdn)
 * [environment](shell.shellinfo.md#environment)
 * [imsEnvironment](shell.shellinfo.md#imsenvironment)
 * [shellInfo](shell.shellinfo.md#shellinfo)
 
 ## Properties
 
+### cdn
+
+•  **cdn**: string
+
+___
+
 ### environment
 
 •  **environment**: string

package/docs/modules/network.md

@@ -50,29 +50,38 @@ const queryResponse = await query({
 
 * [FetchScope](../enums/network.fetchscope.md)
 * [ROUTING](../enums/network.routing.md)
+* [StandardVariables](../enums/network.standardvariables.md)
 
 ### Interfaces
 
 * [ApolloClientOptions](../interfaces/network.apolloclientoptions.md)
+* [DataDedupConfig](../interfaces/network.datadedupconfig.md)
+* [DataPrefetchContract](../interfaces/network.dataprefetchcontract.md)
 * [DefaultMetaData](../interfaces/network.defaultmetadata.md)
+* [FetchCondition](../interfaces/network.fetchcondition.md)
 * [FetchOptions](../interfaces/network.fetchoptions.md)
 * [GraphQLQuery](../interfaces/network.graphqlquery.md)
 * [NetworkApi](../interfaces/network.networkapi.md)
+* [PrefetchOptions](../interfaces/network.prefetchoptions.md)
+* [QueryDefinition](../interfaces/network.querydefinition.md)
 * [QueryRequest](../interfaces/network.queryrequest.md)
 
 ### Type aliases
 
 * [FetchInit](network.md#fetchinit)
 * [GraphQLRegion](network.md#graphqlregion)
+* [PrefetchResponse](network.md#prefetchresponse)
 
 ### Variables
 
 * [DEFAULT\_STATUS\_CODES\_TO\_RETRY](network.md#default_status_codes_to_retry)
+* [FRESH\_MS](network.md#fresh_ms)
 
 ### Functions
 
 * [fetch](network.md#fetch)
 * [getApolloClient](network.md#getapolloclient)
+* [getPrefetched](network.md#getprefetched)
 * [query](network.md#query)
 
 ## Type aliases
@@ -96,6 +105,18 @@ ___
 
 Ƭ  **GraphQLRegion**: \"va7\" \| \"aus5\" \| \"nld2\"
 
+___
+
+### PrefetchResponse
+
+Ƭ  **PrefetchResponse**<T\>: [CacheEntry](cache.md#cacheentry)<T\> & { getFresh?: undefined \| () => Promise<[PrefetchResponse](network.md#prefetchresponse)<T\>\>  }
+
+#### Type parameters:
+
+Name |
+------ |
+`T` |
+
 ## Variables
 
 ### DEFAULT\_STATUS\_CODES\_TO\_RETRY
@@ -104,6 +125,12 @@ ___
 
 Default status codes which imply a transient error and can be retried.
 
+___
+
+### FRESH\_MS
+
+• `Const` **FRESH\_MS**: number = 60 * 1000
+
 ## Functions
 
 ### fetch
@@ -175,6 +202,34 @@ GraphQL query response
 
 ___
 
+### getPrefetched
+
+▸ **getPrefetched**<T\>(`key`: string, `options?`: [PrefetchOptions](../interfaces/network.prefetchoptions.md)): Promise<[PrefetchResponse](network.md#prefetchresponse)<T\>\>
+
+Provides an interface for querying known data.
+Data querying and caching are managed in Unified Shell in advance.
+
+This is an experimental feature.
+
+#### Type parameters:
+
+Name |
+------ |
+`T` |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`key` | string | Data Contract key |
+`options?` | [PrefetchOptions](../interfaces/network.prefetchoptions.md) | Prefetch options |
+
+**Returns:** Promise<[PrefetchResponse](network.md#prefetchresponse)<T\>\>
+
+Promise for the contract execution response
+
+___
+
 ### query
 
 ▸ **query**(`input`: [QueryRequest](../interfaces/network.queryrequest.md)): Promise<Response\>

package/network/DataContract.d.ts

@@ -0,0 +1,35 @@
+/*************************************************************************
+ * Copyright 2022 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
+ * accordance with the terms of the Adobe license agreement accompanying
+ * it. If you have received this file from a source other than Adobe,
+ * then your use, modification, or distribution of it requires the prior
+ * written permission of Adobe.
+ **************************************************************************/
+import { CacheExpiry, CacheScope } from '../cache';
+import { FetchScope } from '../network';
+export interface FetchCondition {
+    serviceCodes?: string | string[];
+}
+export interface QueryContract<V> {
+    fetchScope: FetchScope;
+    ignoreErrorsOnPaths?: string[];
+    query: string;
+    root?: string;
+    variables: V;
+}
+interface DataContract<T, V = undefined> {
+    defaultValue: T;
+    expiry: CacheExpiry;
+    fetchWhen?: FetchCondition;
+    gql?: QueryContract<V>;
+    isSensitive: boolean;
+    key: string;
+    revalidate: boolean;
+    revalidateAfterSec?: number;
+    scope: CacheScope;
+    shared: boolean;
+}
+export default DataContract;

package/network/DataContract.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DataContract.js.map

package/network/DataContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataContract.js","sourceRoot":"","sources":["DataContract.ts"],"names":[],"mappings":""}

package/network/DataPrefetchContract.d.ts

@@ -0,0 +1,150 @@
+/*************************************************************************
+ * Copyright 2022 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
+ * accordance with the terms of the Adobe license agreement accompanying
+ * it. If you have received this file from a source other than Adobe,
+ * then your use, modification, or distribution of it requires the prior
+ * written permission of Adobe.
+ **************************************************************************/
+import { CacheExpiry, CacheScope } from '../cache';
+import { FetchScope, GraphQLQuery } from '../network';
+/**
+ * @packageDocumentation
+ * @module network
+ */
+export declare const FRESH_MS: number;
+export declare enum StandardVariables {
+    ACP_FD = "acpFulfillableData",
+    CACHED_TS = "cached.createdAt"
+}
+/**
+ * Defines the conditions when certain data can be fetched.
+ * When conditions are not met, default data will be returned but not cached.
+ */
+export interface FetchCondition {
+    /**
+     * Service Codes that needs to be present (For the current org) in order to execute the query.
+     * This is useful when a query only makes sense if a certain product is provisioned for the current user.
+     */
+    serviceCodes?: string | string[];
+}
+/**
+ * Defines a GraphQL query that will be executed to fetch the data exposed by this contract.
+ */
+export interface QueryDefinition extends GraphQLQuery {
+    /**
+     * When provided, the data at the certain path will be returned.
+     * If not provided, the entire GraphQL response will be returned.
+     */
+    dataPath?: string;
+    /**
+     * Fetch scope. Controls which headers are sent with the query.
+     * See fetch documentation for more info.
+     */
+    fetchScope: FetchScope;
+    /**
+     * Do not fail (throw) when encountering errors while processing the query if the errors
+     * happened on certain paths.
+     */
+    ignoreErrorsOnPaths?: string[];
+}
+export interface DataDedupConfig {
+    /**
+     * An array of elements that needs to be merged and deduped across fresh and cached data.
+     */
+    arrayElement: string;
+    /**
+     * A key that will be used to deduplicate the array element.
+     */
+    keyField: string;
+}
+/**
+ * Defines a data contract which will be executed by Unified Shell on behalf ot the requesting application.
+ */
+export default interface DataPrefetchContract<T> {
+    /**
+     * Default value to return if the data execution is skipped.
+     */
+    defaultValue: T;
+    /**
+     * Cache expiry. Can be one of the set values defined by the Cache API, or a numeric cache ttl (in seconds).
+     */
+    expiry: CacheExpiry;
+    /**
+     * Defines the conditions when certain data can be fetched.
+     * When conditions are not met, the default value above will be returned (But not cached).
+     */
+    fetchWhen?: FetchCondition;
+    /**
+     * GraphQL used to fulfill this data contract.
+     * Note: Currently GraphQL is the only supported method for data contracts.
+     */
+    gql?: QueryDefinition;
+    /**
+     * Is the data sensitive? (PII or other sensitive data).
+     * Sensitive data can only be cached in the browser's session storage
+     * Non-sensitive data can be cached in the standard Cache storage.
+     */
+    isSensitive: boolean;
+    /**
+     * Unique key associated with this contract.
+     * Will be used by the calling application to get access to the data.
+     */
+    key: string;
+    /**
+     * Defines specific behavior for refresh.
+     * This is optional, by default refreshing data and fetching new will yield the same results.
+     */
+    refreshData?: {
+        /**
+         * Cached & Fresh Data deduplication and merge configuration.
+         */
+        dedup?: DataDedupConfig;
+        /**
+         * GraphQL query to use for refresh.
+         */
+        gql?: QueryDefinition;
+        /**
+         * An optional array of root level elements that need to be retained from the cached data.
+         */
+        keepOriginal?: string[];
+    };
+    /**
+     * When true, data will be fetched even when a cache is available.
+     * In this case, the query will return the cached data and at the same time fetch fresh data from the network.
+     * (stale-while-revalidate strategy)
+     */
+    revalidate: {
+        /**
+         * When true, data will be fetched even when a cache is available.
+         * In this case, the query will return the cached data and at the same time fetch fresh data from the network.
+         * (stale-while-revalidate strategy)
+         */
+        enabled: boolean;
+        /**
+         * If true, revalidation will be done right away
+         * If false, revalidation will be done when the browser is idle
+         * (On browsers where requestIdleCallback is supported, otherwise right away)
+         * Optional - Defaults to false
+         */
+        immediate?: boolean;
+        /**
+         * Used in conjunction with revalidate = true. Threshold for revalidating data from the network.
+         * When set the query will return the cached data and if the cache is older than the set threshold,
+         * fetch fresh data from the network.
+         Optional - Defaults to 0 (immediate)
+         */
+        revalidateAfterSec?: number;
+    };
+    /**
+     * Cache scope as defined by the Cache API.
+     */
+    scope: CacheScope;
+    /**
+     * If true, this data will be accessible to all experience cloud applications.
+     * Otherwise, data will be cached against the requesting application.
+     */
+    shared: boolean;
+}

package/network/DataPrefetchContract.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardVariables = exports.FRESH_MS = void 0;
+/**
+ * @packageDocumentation
+ * @module network
+ */
+exports.FRESH_MS = 60 * 1000; // One minute.
+var StandardVariables;
+(function (StandardVariables) {
+    StandardVariables["ACP_FD"] = "acpFulfillableData";
+    StandardVariables["CACHED_TS"] = "cached.createdAt";
+})(StandardVariables = exports.StandardVariables || (exports.StandardVariables = {}));
+//# sourceMappingURL=DataPrefetchContract.js.map

package/network/DataPrefetchContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataPrefetchContract.js","sourceRoot":"","sources":["DataPrefetchContract.ts"],"names":[],"mappings":";;;AAaA;;;GAGG;AAEU,QAAA,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,cAAc;AAEjD,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,mDAA8B,CAAA;AAChC,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B"}

package/network.d.ts

@@ -52,6 +52,7 @@
  * @module network
  */
 import type { ApolloClient, ApolloLink, InMemoryCache, InMemoryCacheConfig } from '@apollo/client';
+import { CacheEntry } from './cache';
 import type { gql } from 'graphql-tag';
 /**
  * Default status codes which imply a transient error and can be retried.
@@ -219,6 +220,22 @@ export interface DefaultMetaData {
     imsOrg?: string;
     sandbox?: Record<string, any>;
 }
+export declare type PrefetchResponse<T> = CacheEntry<T> & {
+    getFresh?: () => Promise<PrefetchResponse<T>>;
+};
+/**
+ * Data prefetch options
+ */
+export interface PrefetchOptions {
+    /**
+     * Must return recent data - Created after provided time
+     */
+    createdAfter?: number;
+    /**
+     * If returning cached result, revalidate immediatelly.
+     */
+    revalidateImmediately?: boolean;
+}
 export declare enum ROUTING {
     /**
      * Route by the AEP region found in the user profile
@@ -400,6 +417,17 @@ export interface NetworkApi {
      * @returns The promise for the response to the fetch operation.
      */
     fetch(input: RequestInfo, init?: FetchInit): Promise<Response>;
+    /**
+     * Provides an interface for querying known data.
+     * Data querying and caching are managed in Unified Shell in advance.
+     *
+     * This is an experimental feature.
+     * @template T
+     * @param key - Data Contract key
+     * @param options - Prefetch options
+     * @returns Promise for the contract execution response
+     */
+    getPrefetched<T>(key: string, options?: PrefetchOptions): Promise<PrefetchResponse<T>>;
     /**
      * Provides an interface for querying resources via GraphqQL.
      * In order to consume query, please make sure the respective query resolver is
@@ -486,6 +514,17 @@ export interface NetworkApi {
  * @returns The promise for the response to the fetch operation.
  */
 export declare function fetch(input: RequestInfo, init?: FetchInit): Promise<Response>;
+/**
+ * Provides an interface for querying known data.
+ * Data querying and caching are managed in Unified Shell in advance.
+ *
+ * This is an experimental feature.
+ * @template T
+ * @param key - Data Contract key
+ * @param options - Prefetch options
+ * @returns Promise for the contract execution response
+ */
+export declare function getPrefetched<T>(key: string, options?: PrefetchOptions): Promise<PrefetchResponse<T>>;
 /**
  * Provides an interface for querying resources via GraphqQL.
  * In order to consume query, please make sure the respective query resolver is

package/network.js

@@ -10,7 +10,7 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApolloClient = exports.query = exports.fetch = exports.FetchScope = exports.ROUTING = exports.DEFAULT_STATUS_CODES_TO_RETRY = void 0;
+exports.getApolloClient = exports.query = exports.getPrefetched = exports.fetch = exports.FetchScope = exports.ROUTING = exports.DEFAULT_STATUS_CODES_TO_RETRY = void 0;
 const Global_1 = require("./src/Global");
 /**
  * Default status codes which imply a transient error and can be retried.
@@ -102,6 +102,20 @@ function fetch(input, init) {
     return Global_1.getImpl('network').fetch(input, init);
 }
 exports.fetch = fetch;
+/**
+ * Provides an interface for querying known data.
+ * Data querying and caching are managed in Unified Shell in advance.
+ *
+ * This is an experimental feature.
+ * @template T
+ * @param key - Data Contract key
+ * @param options - Prefetch options
+ * @returns Promise for the contract execution response
+ */
+function getPrefetched(key, options) {
+    return Global_1.getImpl('network').getPrefetched(key, options);
+}
+exports.getPrefetched = getPrefetched;
 /**
  * Provides an interface for querying resources via GraphqQL.
  * In order to consume query, please make sure the respective query resolver is

package/network.js.map

@@ -1 +1 @@
-{"version":3,"file":"network.js","sourceRoot":"","sources":["network.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AA+C5E,yCAAqC;AAGrC;;GAEG;AACU,QAAA,6BAA6B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAuKlE,IAAY,OAaX;AAbD,WAAY,OAAO;IACjB;;OAEG;IACH,+DAAiB,CAAA;IACjB;;OAEG;IACH,2CAAO,CAAA;IACP;;OAEG;IACH,yEAAsB,CAAA;AACxB,CAAC,EAbW,OAAO,GAAP,eAAO,KAAP,eAAO,QAalB;AAqFD;;GAEG;AACH,IAAY,UAqCX;AArCD,WAAY,UAAU;IACpB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;;OAIG;IACH,2BAAa,CAAA;IACb;;;;;OAKG;IACH,yBAAW,CAAA;IACX;;;;;;OAMG;IACH,iCAAmB,CAAA;IACnB;;;;;;;;OAQG;IACH,2CAA6B,CAAA;AAC/B,CAAC,EArCW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqCrB;AA+GD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,KAAK,CAAC,KAAkB,EAAE,IAAgB;IACxD,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAFD,sBAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,KAAK,CAAC,KAAmB;IACvC,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAFD,sBAEC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,eAAe,CAC7B,OAA6B;IAK7B,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAPD,0CAOC"}
+{"version":3,"file":"network.js","sourceRoot":"","sources":["network.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAgD5E,yCAAqC;AAGrC;;GAEG;AACU,QAAA,6BAA6B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAyLlE,IAAY,OAaX;AAbD,WAAY,OAAO;IACjB;;OAEG;IACH,+DAAiB,CAAA;IACjB;;OAEG;IACH,2CAAO,CAAA;IACP;;OAEG;IACH,yEAAsB,CAAA;AACxB,CAAC,EAbW,OAAO,GAAP,eAAO,KAAP,eAAO,QAalB;AAqFD;;GAEG;AACH,IAAY,UAqCX;AArCD,WAAY,UAAU;IACpB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;;OAIG;IACH,2BAAa,CAAA;IACb;;;;;OAKG;IACH,yBAAW,CAAA;IACX;;;;;;OAMG;IACH,iCAAmB,CAAA;IACnB;;;;;;;;OAQG;IACH,2CAA6B,CAAA;AAC/B,CAAC,EArCW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqCrB;AA2HD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,KAAK,CAAC,KAAkB,EAAE,IAAgB;IACxD,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAFD,sBAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAAI,GAAW,EAAE,OAAyB;IACrE,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACxD,CAAC;AAFD,sCAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,KAAK,CAAC,KAAmB;IACvC,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAFD,sBAEC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,eAAe,CAC7B,OAA6B;IAK7B,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAPD,0CAOC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/exc-app",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {
@@ -26,15 +26,14 @@
   },
   "dependencies": {
     "@apollo/client": "3.5.7",
-    "graphql": "^15.0.0",
+    "graphql": "15.5.3",
     "graphql-tag": "2.12.6"
   },
   "devDependencies": {
     "cross-env": "7.0.3",
-    "enzyme": "3.11.0",
     "eslint": "8.1.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-jsdoc": "31.6.1",
+    "eslint-plugin-jsdoc": "36.1.1",
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-rulesdir": "0.2.1",
     "glob": "7.1.7",

package/sidenav.d.ts

@@ -204,7 +204,7 @@ export interface SidenavApi extends EventEmitter<SidenavInfoEvent> {
      */
     config?: NavConfig;
     /**
-     * Whether the Sidenav nav should start out as collapsed or not.
+     * Boolean representing whether the sidenav drawer is presently open or closed.
      *
      * ***Example:***
      *
@@ -219,7 +219,7 @@ export interface SidenavApi extends EventEmitter<SidenavInfoEvent> {
      */
     get<T extends keyof SidenavInfo>(type: T): Promise<SidenavInfo[T]>;
     /**
-     * Whether the Sidenav nav should currently be visible or not.
+     * Boolean representing whether Sidenav and its button should be rendered at all.
      *
      * ***Example:***
      *

package/tests/network.test.js

@@ -26,11 +26,13 @@ const network_1 = require("../network");
 const Global_1 = __importDefault(require("../src/Global"));
 describe('network.ts', () => {
     const fetchMock = jest.fn();
+    const getPrefetchedMock = jest.fn();
     const queryMock = jest.fn();
     const getApolloClientMock = jest.fn();
     const networkMock = {
         fetch: fetchMock,
         getApolloClient: getApolloClientMock,
+        getPrefetched: getPrefetchedMock,
         query: queryMock
     };
     beforeAll(() => {
@@ -47,6 +49,14 @@ describe('network.ts', () => {
         expect(fetchMock).toHaveBeenCalledTimes(1);
         expect(fetchMock).toHaveBeenCalledWith('url', { auth: 'Header' });
     }));
+    test('getPrefetched', () => __awaiter(void 0, void 0, void 0, function* () {
+        const res = { status: 'ok' };
+        getPrefetchedMock.mockResolvedValue(res);
+        const result = yield network_1.getPrefetched('key', { createdAfter: 100 });
+        expect(result).toEqual(res);
+        expect(getPrefetchedMock).toHaveBeenCalledTimes(1);
+        expect(getPrefetchedMock).toHaveBeenCalledWith('key', { createdAfter: 100 });
+    }));
     test('query', () => __awaiter(void 0, void 0, void 0, function* () {
         const res = { status: 'ok' };
         queryMock.mockResolvedValue(res);

package/tests/network.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"network.test.js","sourceRoot":"","sources":["network.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA;;;;;;;;;4EAS4E;AAC5E,wCAAqE;AACrE,2DAA8C;AAE9C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC5B,MAAM,mBAAmB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAEtC,MAAM,WAAW,GAAG;QAClB,KAAK,EAAE,SAAS;QAChB,eAAe,EAAE,mBAAmB;QACpC,KAAK,EAAE,SAAS;KACH,CAAC;IAEhB,SAAS,CAAC,GAAG,EAAE;QACZ,gBAAM,CAAC,oBAAoB,CAAa,GAAG;YAC1C,OAAO,EAAE,WAAW;SACV,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IAEtC,IAAI,CAAC,OAAO,EAAE,GAAS,EAAE;QACvB,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,eAAK,CAAC,KAAK,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAC;IAClE,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,GAAS,EAAE;QACvB,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,eAAK,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,OAAO,EAAC,EAAC,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,OAAO,EAAC,EAAC,CAAC,CAAC;IACnE,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,iBAAiB,EAAE,GAAS,EAAE;QACjC,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,mBAAmB,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,yBAAe,CAAC,EAAC,GAAG,EAAE,IAAI,EAAC,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,EAAC,GAAG,EAAE,IAAI,EAAC,CAAC,CAAC;IAChE,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"network.test.js","sourceRoot":"","sources":["network.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA;;;;;;;;;4EAS4E;AAC5E,wCAAoF;AACpF,2DAA8C;AAE9C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC5B,MAAM,iBAAiB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACpC,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC5B,MAAM,mBAAmB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAEtC,MAAM,WAAW,GAAG;QAClB,KAAK,EAAE,SAAS;QAChB,eAAe,EAAE,mBAAmB;QACpC,aAAa,EAAE,iBAAiB;QAChC,KAAK,EAAE,SAAS;KACH,CAAC;IAEhB,SAAS,CAAC,GAAG,EAAE;QACZ,gBAAM,CAAC,oBAAoB,CAAa,GAAG;YAC1C,OAAO,EAAE,WAAW;SACV,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IAEtC,IAAI,CAAC,OAAO,EAAE,GAAS,EAAE;QACvB,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,eAAK,CAAC,KAAK,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAC;IAClE,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,eAAe,EAAE,GAAS,EAAE;QAC/B,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,iBAAiB,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,uBAAa,CAAC,KAAK,EAAE,EAAC,YAAY,EAAE,GAAG,EAAC,CAAC,CAAC;QAC/D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,iBAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAC,YAAY,EAAE,GAAG,EAAC,CAAC,CAAC;IAC7E,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,GAAS,EAAE;QACvB,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,eAAK,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,OAAO,EAAC,EAAC,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,OAAO,EAAC,EAAC,CAAC,CAAC;IACnE,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,iBAAiB,EAAE,GAAS,EAAE;QACjC,MAAM,GAAG,GAAG,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC;QAC3B,mBAAmB,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,yBAAe,CAAC,EAAC,GAAG,EAAE,IAAI,EAAC,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,EAAC,GAAG,EAAE,IAAI,EAAC,CAAC,CAAC;IAChE,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/version.d.ts

@@ -8,5 +8,5 @@
  * then your use, modification, or distribution of it requires the prior
  * written permission of Adobe.
  **************************************************************************/
-declare const EXC_APP_VERSION = "1.0.4";
+declare const EXC_APP_VERSION = "1.0.7";
 export default EXC_APP_VERSION;

package/version.js

@@ -10,6 +10,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * then your use, modification, or distribution of it requires the prior
  * written permission of Adobe.
  **************************************************************************/
-const EXC_APP_VERSION = '1.0.4';
+const EXC_APP_VERSION = '1.0.7';
 exports.default = EXC_APP_VERSION;
 //# sourceMappingURL=version.js.map