@lightdash/common 2.468.0 → 2.469.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,4 +34,20 @@ export type LearnLessonExpectation = {
34
34
  * the learner saying what is missing or where it ended up instead.
35
35
  */
36
36
  export declare const checkLearnLessonEntry: (content: string, expected: LearnLessonExpectation) => string | null;
37
+ /**
38
+ * What a content-as-code lesson asks of a downloaded chart file: its slug
39
+ * left as it is, because `lightdash upload` finds the chart by it, and its
40
+ * name changed to `name`. The rest of the file is the learner's own.
41
+ */
42
+ export type ContentAsCodeExpectation = {
43
+ kind: 'contentAsCode';
44
+ slug: string;
45
+ name: string;
46
+ };
47
+ export declare const isContentAsCodeExpectation: (expect: Record<string, string> | undefined) => expect is ContentAsCodeExpectation & Record<string, string>;
48
+ /**
49
+ * Null when the chart file holds what the lesson expects; otherwise one line
50
+ * for the learner saying what to put right.
51
+ */
52
+ export declare const checkContentAsCodeEntry: (content: string, expected: Pick<ContentAsCodeExpectation, 'slug' | 'name'>) => string | null;
37
53
  //# sourceMappingURL=learnSandbox.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"learnSandbox.d.ts","sourceRoot":"","sources":["../../../src/utils/learnSandbox.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAAM,GAAG,IAOrE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,+BAA+B,YAAa,MAAM,KAAG,MAKjE,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAwBF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,YACrB,MAAM,YACL,sBAAsB,KACjC,MAAM,GAAG,IA0CX,CAAC"}
1
+ {"version":3,"file":"learnSandbox.d.ts","sourceRoot":"","sources":["../../../src/utils/learnSandbox.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAAM,GAAG,IAOrE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,+BAA+B,YAAa,MAAM,KAAG,MAKjE,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAwBF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,YACrB,MAAM,YACL,sBAAsB,KACjC,MAAM,GAAG,IA0CX,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,eAAO,MAAM,0BAA0B,WAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,KAC3C,MAAM,IAAI,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAI1B,CAAC;AAEpC;;;GAGG;AACH,eAAO,MAAM,uBAAuB,YACvB,MAAM,YACL,IAAI,CAAC,wBAAwB,EAAE,MAAM,GAAG,MAAM,CAAC,KAC1D,MAAM,GAAG,IAiBX,CAAC"}
@@ -73,4 +73,30 @@ export const checkLearnLessonEntry = (content, expected) => {
73
73
  }
74
74
  return `Add ${expected.field} under the ${expected.column} column's ${expected.under}`;
75
75
  };
76
+ export const isContentAsCodeExpectation = (expect) => expect !== undefined &&
77
+ expect.kind === 'contentAsCode' &&
78
+ typeof expect.slug === 'string' &&
79
+ typeof expect.name === 'string';
80
+ /**
81
+ * Null when the chart file holds what the lesson expects; otherwise one line
82
+ * for the learner saying what to put right.
83
+ */
84
+ export const checkContentAsCodeEntry = (content, expected) => {
85
+ let doc;
86
+ try {
87
+ doc = parseYaml(content);
88
+ }
89
+ catch (e) {
90
+ return describeLearnWorkspaceYamlError(e instanceof Error ? e.message : 'Invalid YAML').replace(/ to continue$/, ', then check again');
91
+ }
92
+ if (!isRecord(doc))
93
+ return 'This file no longer describes a chart';
94
+ if (doc.slug !== expected.slug) {
95
+ return `Keep the slug as ${expected.slug}: upload finds the chart by it`;
96
+ }
97
+ if (doc.name !== expected.name) {
98
+ return `Change the chart's name to ${expected.name}`;
99
+ }
100
+ return null;
101
+ };
76
102
  //# sourceMappingURL=learnSandbox.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"learnSandbox.js","sourceRoot":"","sources":["../../../src/utils/learnSandbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,OAAe,EAAiB,EAAE;IACzE,IAAI,CAAC;QACD,SAAS,CAAC,OAAO,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC;IAC3D,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,OAAe,EAAU,EAAE;IACvE,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,IAAI;QACP,CAAC,CAAC,8BAA8B,IAAI,cAAc;QAClD,CAAC,CAAC,gCAAgC,CAAC;AAC3C,CAAC,CAAC;AAsBF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAClE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,KAAc,EAA6B,EAAE,CAC7D,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAEvD,2EAA2E;AAC3E,MAAM,UAAU,GAAG,CAAC,MAA+B,EAAa,EAAE,CAAC;IAC/D,MAAM,CAAC,IAAI;IACX,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;CAC3D,CAAC;AAEF,MAAM,WAAW,GAAG,CAChB,MAA+B,EAC/B,KAAa,EACb,KAAa,EACN,EAAE,CACT,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CACnB,CAAC,IAAI,EAAE,EAAE,CACL,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,CACtE,CAAC;AAEN;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,OAAe,EACf,QAAgC,EACnB,EAAE;IACf,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACD,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,+BAA+B,CAClC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAClD,CAAC,OAAO,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,CAAC,KAAK;QAAE,OAAO,OAAO,QAAQ,CAAC,KAAK,kCAAkC,CAAC;IAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1C,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAChE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CACF,CAAC,KAAK,KAAK;YACX,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,CACnE,CAAC;QACF,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,GAAG,QAAQ,CAAC,KAAK,iBAAiB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC5G,CAAC;QACD,OAAO,OAAO,QAAQ,CAAC,KAAK,WAAW,QAAQ,CAAC,KAAK,YAAY,QAAQ,CAAC,KAAK,EAAE,CAAC;IACtF,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO,OAAO,QAAQ,CAAC,MAAM,2BAA2B,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC7E,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACrE,MAAM,WAAW,GAAG,MAAM;SACrB,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;SACrC,IAAI,CACD,CAAC,CAAC,EAAE,EAAE,CACF,CAAC,KAAK,MAAM,IAAI,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CACrE,CAAC;IACN,IAAI,WAAW,EAAE,CAAC;QACd,OAAO,GAAG,QAAQ,CAAC,KAAK,iBAAiB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,QAAQ,CAAC,MAAM,EAAE,CAAC;IAChH,CAAC;IACD,OAAO,OAAO,QAAQ,CAAC,KAAK,cAAc,QAAQ,CAAC,MAAM,aAAa,QAAQ,CAAC,KAAK,EAAE,CAAC;AAC3F,CAAC,CAAC"}
1
+ {"version":3,"file":"learnSandbox.js","sourceRoot":"","sources":["../../../src/utils/learnSandbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,OAAe,EAAiB,EAAE;IACzE,IAAI,CAAC;QACD,SAAS,CAAC,OAAO,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC;IAC3D,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,OAAe,EAAU,EAAE;IACvE,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,IAAI;QACP,CAAC,CAAC,8BAA8B,IAAI,cAAc;QAClD,CAAC,CAAC,gCAAgC,CAAC;AAC3C,CAAC,CAAC;AAsBF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAClE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,KAAc,EAA6B,EAAE,CAC7D,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAEvD,2EAA2E;AAC3E,MAAM,UAAU,GAAG,CAAC,MAA+B,EAAa,EAAE,CAAC;IAC/D,MAAM,CAAC,IAAI;IACX,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;CAC3D,CAAC;AAEF,MAAM,WAAW,GAAG,CAChB,MAA+B,EAC/B,KAAa,EACb,KAAa,EACN,EAAE,CACT,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CACnB,CAAC,IAAI,EAAE,EAAE,CACL,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,CACtE,CAAC;AAEN;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,OAAe,EACf,QAAgC,EACnB,EAAE;IACf,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACD,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,+BAA+B,CAClC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAClD,CAAC,OAAO,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,CAAC,KAAK;QAAE,OAAO,OAAO,QAAQ,CAAC,KAAK,kCAAkC,CAAC;IAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1C,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAChE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CACF,CAAC,KAAK,KAAK;YACX,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,CACnE,CAAC;QACF,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,GAAG,QAAQ,CAAC,KAAK,iBAAiB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC5G,CAAC;QACD,OAAO,OAAO,QAAQ,CAAC,KAAK,WAAW,QAAQ,CAAC,KAAK,YAAY,QAAQ,CAAC,KAAK,EAAE,CAAC;IACtF,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO,OAAO,QAAQ,CAAC,MAAM,2BAA2B,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC7E,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACrE,MAAM,WAAW,GAAG,MAAM;SACrB,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;SACrC,IAAI,CACD,CAAC,CAAC,EAAE,EAAE,CACF,CAAC,KAAK,MAAM,IAAI,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CACrE,CAAC;IACN,IAAI,WAAW,EAAE,CAAC;QACd,OAAO,GAAG,QAAQ,CAAC,KAAK,iBAAiB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,QAAQ,CAAC,MAAM,EAAE,CAAC;IAChH,CAAC;IACD,OAAO,OAAO,QAAQ,CAAC,KAAK,cAAc,QAAQ,CAAC,MAAM,aAAa,QAAQ,CAAC,KAAK,EAAE,CAAC;AAC3F,CAAC,CAAC;AAaF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACtC,MAA0C,EACiB,EAAE,CAC7D,MAAM,KAAK,SAAS;IACpB,MAAM,CAAC,IAAI,KAAK,eAAe;IAC/B,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;IAC/B,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC;AAEpC;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACnC,OAAe,EACf,QAAyD,EAC5C,EAAE;IACf,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACD,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,+BAA+B,CAClC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAClD,CAAC,OAAO,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,uCAAuC,CAAC;IACnE,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC7B,OAAO,oBAAoB,QAAQ,CAAC,IAAI,gCAAgC,CAAC;IAC7E,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC7B,OAAO,8BAA8B,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzD,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC"}