2.0.4 (#65)

* # 2.0.3
@craftercms/classes
- Change SDKService.httpGet to use fetch instead of rxjs.ajax
- Fix fetch's mode (for cors)
- Extend support for other fetch modes
- Switch from using URLSearchParams to using query-string for the same purpose

* # 2.0.4
@craftercms/content
- Fix `flatten` argument to getDescriptor getting lost/ignored
@craftercms/models
- Move types from other files into models package
- Adding missing properties to NavigationItem interface

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@craftercms/sdk",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "private": true,
   "workspaces": [
     "packages/*"

packages/content/src/ContentStoreService.ts

@@ -15,10 +15,10 @@
  */
 
 import { Observable } from 'rxjs';
-
 import { crafterConf, SDKService } from '@craftercms/classes';
 import { CrafterConfig, Descriptor, Item } from '@craftercms/models';
 import { composeUrl } from '@craftercms/utils';
+import { map } from 'rxjs/operators';
 
 /**
  * Returns an Item from the content store.
@@ -44,13 +44,23 @@ export interface GetDescriptorConfig {
 export function getDescriptor(path: string): Observable<Descriptor>;
 export function getDescriptor(path: string, config: Partial<CrafterConfig & GetDescriptorConfig>): Observable<Descriptor>;
 export function getDescriptor(path: string, config?: Partial<CrafterConfig & GetDescriptorConfig>): Observable<Descriptor> {
-  config = crafterConf.mix(config);
-  const requestURL = composeUrl(config, config.endpoints.GET_DESCRIPTOR);
-  return SDKService.httpGet(requestURL, {
+  let cfg = crafterConf.mix(config);
+  return SDKService.httpGet(composeUrl(cfg, cfg.endpoints.GET_DESCRIPTOR), {
     url: path,
-    crafterSite: config.site,
+    crafterSite: cfg.site,
     flatten: Boolean(config.flatten)
-  }, config.headers);
+  }, cfg.headers).pipe(
+    // Manually introduce the path into the response as descriptor endpoint does not return it.
+    map((descriptor: Descriptor) => {
+      let prop = typeof descriptor.page === 'undefined' ? 'component' : 'page';
+      return {
+        [prop]: {
+          ...descriptor[prop],
+          localId: path
+        }
+      };
+    })
+  );
 }
 
 /**

packages/content/src/UrlTransformationService.ts

@@ -25,6 +25,7 @@ import { composeUrl } from '@craftercms/utils';
  * @param {string} transformerName - Name of the transformer to apply
  * @param {string} url - URL that will be transformed
  */
+// TODO: transformerName: 'storeUrlToRenderUrl' | 'renderUrlToStoreUrl' | ???
 export function urlTransform(transformerName: string, url: string): Observable<any>;
 export function urlTransform(transformerName: string, url: string, config: CrafterConfig): Observable<any>;
 export function urlTransform(transformerName: string, url: string, config?: CrafterConfig): Observable<any> {

packages/content/src/utils.ts

@@ -14,24 +14,7 @@
  * along with this program. If not, see http://www.gnu.org/licenses/.
  */
 
-import { ContentInstance, Descriptor, Item } from '@craftercms/models';
-
-interface GraphQLResponse {
-  [root: string]: {
-    // Repeating groups & node selectors collection root
-    item?:
-      object[] |
-      Array<{
-        key: string;
-        value: string;
-        component: unknown;
-      }>
-    // Other field types
-    [contentTypeField: string]: unknown
-  }
-}
-
-type DescriptorResponse = Descriptor | Item | GraphQLResponse;
+import { ContentInstance, DescriptorResponse } from '@craftercms/models';
 
 const systemPropMap = {
   guid: 'id',

packages/models/models.ts

@@ -24,3 +24,4 @@ export * from './src/ReduxStore';
 export * from './src/message';
 export * from './src/ContentInstance';
 export * from './src/search';
+export * from './src/GraphQLResponse';

packages/models/src/GraphQLResponse.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+
+export interface GraphQLResponse {
+  [root: string]: {
+    // Repeating groups & node selectors collection root
+    item?:
+      object[] |
+      Array<{
+        key: string;
+        value: string;
+        component: unknown;
+      }>
+    // Other field types
+    [contentTypeField: string]: unknown
+  }
+}

packages/models/src/NavigationItem.ts

@@ -16,8 +16,10 @@
 
 export interface NavigationItem {
   url: string;
+  label: string;
   active: boolean;
   subItems: Array<NavigationItem>;
+  attributes: Record<string, string>;
   [prop: string]: any;
 }
 

packages/models/src/descriptor.ts

@@ -14,8 +14,13 @@
  * along with this program. If not, see http://www.gnu.org/licenses/.
  */
 
+import { Item } from './item';
+import { GraphQLResponse } from './GraphQLResponse';
+
 export interface Descriptor {
   page?: any;
   component?: any;
   [prop: string]: any;
 }
+
+export type DescriptorResponse = Descriptor | Item | GraphQLResponse;