Merge remote-tracking branch 'origin/master' into 185581730-add-points

cms/package.json

@@ -19,6 +19,9 @@
   "author": "Concord Consortium <> (https://concord.org)",
   "license": "MIT",
   "dependencies": {
-    "netlify-cms-app": "^2.15.72"
+    "@types/react": "^18.2.0",
+    "react": "^18.2.0",
+    "decap-cms-app": "^3.1.2",
+    "decap-cms-core": "^3.3.2"
   }
 }

cms/src/cms-collections.ts

@@ -1,39 +1,39 @@
-import { CmsConfig, CmsField, CmsFieldSelect, CmsSelectWidgetOptionObject } from "netlify-cms-core";
-import { urlParams } from "../../src/utilities/url-params";
+import { CmsCollection, CmsConfig, CmsField } from "decap-cms-core";
+import { urlParams } from "./cms-url-params";
 
-const typeField = {
+const typeField: CmsField = {
   label: "Type",
   name: "type",
   widget: "string"
-} as CmsField;
+};
 
-const titleField = {
+const titleField: CmsField = {
   label: "Title",
   name: "title",
   widget: "string"
-} as CmsField;
+};
 
-const tagField = {
+const tagField: Extract<CmsField, {widget: "select"}> = {
   label: "Tag",
   name: "tag",
   widget: "select",
   options: []
-} as CmsFieldSelect;
+};
 
-const previewLinkField = {
+const previewLinkField: CmsField = {
   label: "Preview Link",
   name: "preview-link",
   required: false,
-  widget: "preview-link"
-} as CmsField;
+  widget: "preview-link" as any
+};
 
-const contentField = {
+const contentField: CmsField = {
   label: "Content",
   name: "content",
   widget: "clue" as any
-} as CmsField;
+};
 
-const legacyCurriculumSections = {
+const legacyCurriculumSections: CmsCollection = {
   name: "sections",
   label: "Curriculum Sections",
   label_singular: "Curriculum Section",
@@ -44,7 +44,7 @@ const legacyCurriculumSections = {
   fields: [typeField, previewLinkField, contentField]
 };
 
-const curriculumSections = {
+const curriculumSections: CmsCollection = {
   name: "sections",
   label: "Curriculum Sections",
   label_singular: "Curriculum Section",
@@ -55,7 +55,7 @@ const curriculumSections = {
   fields: [typeField, previewLinkField, contentField]
 };
 
-const teacherGuides = {
+const teacherGuides: CmsCollection = {
   name: "teacherGuides",
   label: "Teacher Guides",
   label_singular: "Teacher Guide",
@@ -66,7 +66,7 @@ const teacherGuides = {
   fields: [typeField, previewLinkField, contentField]
 };
 
-const exemplars = {
+const exemplars: CmsCollection = {
   name: "exemplars",
   label: "Exemplars",
   label_singular: "Exemplar",
@@ -88,20 +88,20 @@ function hasSectionsFolder(myJson: any) {
 
 export function getCmsCollections(unitJson: any): CmsConfig["collections"] {
   if (unitJson.config.commentTags) {
-    const tags = unitJson.config.commentTags;
+    const tags: Record<string, string> = unitJson.config.commentTags;
     const options = Object.entries(tags).map(([value, label]) => ({ label, value }));
-    tagField.options = options as Array<CmsSelectWidgetOptionObject>;
+    tagField.options = options;
   }
 
   if (unitJson && hasSectionsFolder(unitJson)) {
     return [
       teacherGuides,
       curriculumSections,
       exemplars
-    ] as CmsConfig["collections"];
+    ];
   } else {
     return [
       legacyCurriculumSections
-    ] as CmsConfig["collections"];
+    ];
   }
 }

cms/src/cms-url-params.ts

@@ -0,0 +1,34 @@
+import { parse } from "query-string";
+
+/**
+ * This is related to [url-params.ts](../../src/utilities/url-params.ts).
+ * It is a subset of the parameters in that module so the CMS doesn't need to import
+ * all of the dependencies used by `url-params.ts`
+ */
+export interface QueryParams {
+  // string, e.g. "sas" for Stretching and Shrinking or "msa" for Moving Straight Ahead
+  unit?: string;
+
+  //
+  // CMS options (admin.html)
+  //
+
+  // change the branch used in clue-curriculum repository default is author
+  curriculumBranch?: string;
+  // work with a local checkout of the curriculum instead of github
+  localCMSBackend?: boolean;
+  // change the location of the cms-editor.html used by iframe widget to edit
+  // CLUE documents.
+  cmsEditorBase?: string;
+}
+
+export const processUrlParams = (): QueryParams => {
+  const params = parse(location.search);
+  return {
+    ...params,
+    // allows use of localCMSBackend without a value
+    localCMSBackend: (params.localCMSBackend !== undefined),
+  };
+};
+
+export const urlParams = processUrlParams();

cms/src/iframe-control.tsx

@@ -1,8 +1,8 @@
 import React from "react";
 import { Map } from "immutable";
-import { CmsWidgetControlProps } from "netlify-cms-core";
+import { CmsWidgetControlProps } from "decap-cms-core";
 
-import { urlParams } from "../../src/utilities/url-params";
+import { urlParams } from "./cms-url-params";
 import { DEBUG_CMS } from "../../src/lib/debug";
 import { defaultCurriculumBranch } from "./cms-constants";
 

cms/src/init-cms.ts

@@ -1,9 +1,9 @@
 (window as any).CMS_MANUAL_INIT = true;
 
-import CMS from "netlify-cms-app";
-import { CmsBackendType, CmsConfig } from "netlify-cms-core";
+import CMS from "decap-cms-app";
+import { CmsBackendType, CmsConfig } from "decap-cms-core";
 
-import { urlParams } from "../../src/utilities/url-params";
+import { urlParams } from "./cms-url-params";
 import { IframeControl } from "./iframe-control";
 import { JsonControl } from "./json-control";
 import { PreviewLinkControl } from "./preview-link-control";

cms/src/preview-link-control.tsx

@@ -1,12 +1,11 @@
 import React from "react";
-import { CmsWidgetControlProps } from "netlify-cms-core";
+import { CmsWidgetControlProps } from "decap-cms-core";
 
 import { getGuideJson, getUnitJson } from "../../src/models/curriculum/unit-utils";
-import { DocumentModelType } from "../../src/models/document/document";
 import { stripPTNumberFromBranch } from "../../src/utilities/branch-utils";
-import { urlParams } from "../../src/utilities/url-params";
-import { defaultCurriculumBranch } from "./cms-constants";
+import { urlParams } from "./cms-url-params";
 import { CurriculumConfig } from "../../src/models/stores/curriculum-config";
+import { defaultCurriculumBranch } from "./cms-constants";
 
 import curriculumConfigJson from "../../src/clue/curriculum-config.json";
 
@@ -54,9 +53,9 @@ export class PreviewLinkControl extends React.Component<CmsWidgetControlProps, I
     // Finish setting up the preview link after reading the unit json
     this.isTeacherGuide = this.pathParts?.[2] === "teacher-guide";
     if (this.isTeacherGuide) {
-      getGuideJson(this.unit, curriculumConfig).then((unitJson: DocumentModelType) => this.setPreviewLink(unitJson));
+      getGuideJson(this.unit, curriculumConfig).then((unitJson) => this.setPreviewLink(unitJson));
     } else {
-      getUnitJson(this.unit, curriculumConfig).then((unitJson: DocumentModelType) => this.setPreviewLink(unitJson));
+      getUnitJson(this.unit, curriculumConfig).then((unitJson) => this.setPreviewLink(unitJson));
     }
 
     this.state = {

cms/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["src/**/*"],
+  "exclude": ["**/node_modules", "**/.*/"]
+}