@uniformdev/canvas 19.90.0 → 19.91.0

package/dist/index.d.mts

@@ -13335,9 +13335,11 @@ type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, '
 
 type CanvasClientOptions = ClientOptions & {
     edgeApiHost?: string;
+    disableSWR?: boolean;
 };
 declare class CanvasClient extends ApiClient<CanvasClientOptions> {
     private edgeApiHost;
+    private edgeApiRequestInit?;
     constructor(options: CanvasClientOptions);
     /** Fetches lists of Canvas compositions, optionally by type */
     getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & ({
@@ -13393,6 +13395,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
             canBeComposition?: boolean | undefined;
             parameters?: {
                 id: string;
+                /** Fetches a component definition's composition defaults */
                 name: string;
                 helpText?: string | undefined;
                 type: string;
@@ -14028,6 +14031,7 @@ type RichTextParamValue = SerializedEditorState | undefined | null;
 
 type ContentClientOptions = ClientOptions & {
     edgeApiHost?: string;
+    disableSWR?: boolean;
 };
 declare class ContentClient extends ApiClient<ContentClientOptions> {
     #private;
@@ -14709,6 +14713,7 @@ declare class PromptClient extends ApiClient {
 
 type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
     edgeApiHost?: string;
+    disableSWR?: boolean;
 };
 /** A route API response with edgehancer composition result */
 type ResolvedRouteGetResponse = RouteGetResponseNotFound | RouteGetResponseRedirect | RouteGetResponseEdgehancedComposition;

package/dist/index.d.ts

@@ -13335,9 +13335,11 @@ type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, '
 
 type CanvasClientOptions = ClientOptions & {
     edgeApiHost?: string;
+    disableSWR?: boolean;
 };
 declare class CanvasClient extends ApiClient<CanvasClientOptions> {
     private edgeApiHost;
+    private edgeApiRequestInit?;
     constructor(options: CanvasClientOptions);
     /** Fetches lists of Canvas compositions, optionally by type */
     getCompositionList(params?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'> & ({
@@ -13393,6 +13395,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
             canBeComposition?: boolean | undefined;
             parameters?: {
                 id: string;
+                /** Fetches a component definition's composition defaults */
                 name: string;
                 helpText?: string | undefined;
                 type: string;
@@ -14028,6 +14031,7 @@ type RichTextParamValue = SerializedEditorState | undefined | null;
 
 type ContentClientOptions = ClientOptions & {
     edgeApiHost?: string;
+    disableSWR?: boolean;
 };
 declare class ContentClient extends ApiClient<ContentClientOptions> {
     #private;
@@ -14709,6 +14713,7 @@ declare class PromptClient extends ApiClient {
 
 type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
     edgeApiHost?: string;
+    disableSWR?: boolean;
 };
 /** A route API response with edgehancer composition result */
 type ResolvedRouteGetResponse = RouteGetResponseNotFound | RouteGetResponseRedirect | RouteGetResponseEdgehancedComposition;

package/dist/index.esm.js

@@ -476,6 +476,7 @@ var CanvasClient = class extends ApiClient {
     }
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+    this.edgeApiRequestInit = options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0;
   }
   /** Fetches lists of Canvas compositions, optionally by type */
   async getCompositionList(params = {}) {
@@ -491,7 +492,7 @@ var CanvasClient = class extends ApiClient {
       ...params.diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
@@ -531,7 +532,7 @@ var CanvasClient = class extends ApiClient {
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   /** Updates or creates a Canvas component definition */
   async updateComposition(body) {
@@ -708,8 +709,15 @@ var _ContentClient = class _ContentClient extends ApiClient4 {
   getEntries(options) {
     const { projectId } = this.options;
     const { skipDataResolution, ...params } = options;
-    const fetchUri = skipDataResolution ? this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId }) : this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
-    return this.apiClient(fetchUri);
+    if (skipDataResolution) {
+      const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
+      return this.apiClient(url);
+    }
+    const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
+    return this.apiClient(
+      edgeUrl,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
   /** Fetches historical versions of an entry */
   async getEntryHistory(options) {
@@ -2296,7 +2304,10 @@ var RouteClient = class extends ApiClient9 {
   async getRoute(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
-    return await this.apiClient(fetchUri);
+    return await this.apiClient(
+      fetchUri,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
 };
 

package/dist/index.js

@@ -603,6 +603,7 @@ var CanvasClient = class extends import_api2.ApiClient {
     }
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+    this.edgeApiRequestInit = options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0;
   }
   /** Fetches lists of Canvas compositions, optionally by type */
   async getCompositionList(params = {}) {
@@ -618,7 +619,7 @@ var CanvasClient = class extends import_api2.ApiClient {
       ...params.diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
@@ -658,7 +659,7 @@ var CanvasClient = class extends import_api2.ApiClient {
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   /** Updates or creates a Canvas component definition */
   async updateComposition(body) {
@@ -835,8 +836,15 @@ var _ContentClient = class _ContentClient extends import_api5.ApiClient {
   getEntries(options) {
     const { projectId } = this.options;
     const { skipDataResolution, ...params } = options;
-    const fetchUri = skipDataResolution ? this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId }) : this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
-    return this.apiClient(fetchUri);
+    if (skipDataResolution) {
+      const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
+      return this.apiClient(url);
+    }
+    const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
+    return this.apiClient(
+      edgeUrl,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
   /** Fetches historical versions of an entry */
   async getEntryHistory(options) {
@@ -2423,7 +2431,10 @@ var RouteClient = class extends import_api10.ApiClient {
   async getRoute(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
-    return await this.apiClient(fetchUri);
+    return await this.apiClient(
+      fetchUri,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
 };
 

package/dist/index.mjs

@@ -476,6 +476,7 @@ var CanvasClient = class extends ApiClient {
     }
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+    this.edgeApiRequestInit = options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0;
   }
   /** Fetches lists of Canvas compositions, optionally by type */
   async getCompositionList(params = {}) {
@@ -491,7 +492,7 @@ var CanvasClient = class extends ApiClient {
       ...params.diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
@@ -531,7 +532,7 @@ var CanvasClient = class extends ApiClient {
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   /** Updates or creates a Canvas component definition */
   async updateComposition(body) {
@@ -708,8 +709,15 @@ var _ContentClient = class _ContentClient extends ApiClient4 {
   getEntries(options) {
     const { projectId } = this.options;
     const { skipDataResolution, ...params } = options;
-    const fetchUri = skipDataResolution ? this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId }) : this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
-    return this.apiClient(fetchUri);
+    if (skipDataResolution) {
+      const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
+      return this.apiClient(url);
+    }
+    const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
+    return this.apiClient(
+      edgeUrl,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
   /** Fetches historical versions of an entry */
   async getEntryHistory(options) {
@@ -2296,7 +2304,10 @@ var RouteClient = class extends ApiClient9 {
   async getRoute(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
-    return await this.apiClient(fetchUri);
+    return await this.apiClient(
+      fetchUri,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.90.0",
+  "version": "19.91.0",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -38,8 +38,8 @@
     "pusher-js": "8.2.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "19.90.0",
-    "@uniformdev/context": "19.90.0",
+    "@uniformdev/assets": "19.91.0",
+    "@uniformdev/context": "19.91.0",
     "immer": "10.0.3"
   },
   "files": [
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5fcbc2f570abedb01f09730eb986f024429e2422"
+  "gitHead": "c1d1a232c177a29f73ec0334d5b70e11fc6f4d77"
 }