@vtex-email/cli 0.0.0 → 0.2.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.
- package/dist/bin.js +29 -70
- package/dist/config/config.d.ts +0 -4
- package/dist/config/config.d.ts.map +1 -1
- package/dist/index.js +0 -4
- package/dist/project/build-project.d.ts.map +1 -1
- package/dist/project/discover.d.ts +1 -2
- package/dist/project/discover.d.ts.map +1 -1
- package/dist/project/fixtures.d.ts.map +1 -1
- package/dist/project/types.d.ts +2 -9
- package/dist/project/types.d.ts.map +1 -1
- package/dist/project.js +29 -70
- package/package.json +8 -3
package/dist/bin.js
CHANGED
|
@@ -418,6 +418,7 @@ async function line(stream, text) {
|
|
|
418
418
|
|
|
419
419
|
// src/project/build-project.ts
|
|
420
420
|
import { errorDiagnostic as errorDiagnostic10, syntaxHelperNames as syntaxHelperNames2 } from "@vtex-email/core";
|
|
421
|
+
import { p0Profile } from "@vtex-email/vtex";
|
|
421
422
|
|
|
422
423
|
// src/config/load-config.ts
|
|
423
424
|
import { errorDiagnostic as errorDiagnostic3 } from "@vtex-email/core";
|
|
@@ -596,9 +597,6 @@ var ConfigSchema = z.strictObject({
|
|
|
596
597
|
outDir: z.string().min(1),
|
|
597
598
|
fixturesDir: z.string().min(1).optional(),
|
|
598
599
|
schemasDir: z.string().min(1).optional(),
|
|
599
|
-
target: z.strictObject({
|
|
600
|
-
profile: z.string().min(1)
|
|
601
|
-
}),
|
|
602
600
|
i18n: z.strictObject({
|
|
603
601
|
locales: z.array(z.string().min(1)).min(1),
|
|
604
602
|
defaultLocale: z.string().min(1),
|
|
@@ -659,7 +657,6 @@ function validateConfig(value, configDir) {
|
|
|
659
657
|
fixturesDir,
|
|
660
658
|
schemasDir,
|
|
661
659
|
localePath: parsed2.data.i18n.localePath ?? null,
|
|
662
|
-
profilePath: path3.resolve(configDir, parsed2.data.target.profile),
|
|
663
660
|
locales: parsed2.data.i18n.locales,
|
|
664
661
|
defaultLocale: parsed2.data.i18n.defaultLocale,
|
|
665
662
|
catalogs: parsed2.data.i18n.catalogs,
|
|
@@ -750,7 +747,7 @@ function isFlatCatalog(value) {
|
|
|
750
747
|
}
|
|
751
748
|
|
|
752
749
|
// src/project/fixtures.ts
|
|
753
|
-
import { checkFixture, errorDiagnostic as errorDiagnostic5 } from "@vtex-email/core";
|
|
750
|
+
import { checkFixture, errorDiagnostic as errorDiagnostic5, fixtureFileSchema } from "@vtex-email/core";
|
|
754
751
|
|
|
755
752
|
// ../../node_modules/.pnpm/jsonc-parser@3.3.1/node_modules/jsonc-parser/lib/esm/impl/scanner.js
|
|
756
753
|
function createScanner(text, ignoreTrivia = false) {
|
|
@@ -1664,6 +1661,19 @@ async function readFixtures(configDir, emailId, fixturesRelative, diagnostics) {
|
|
|
1664
1661
|
return [];
|
|
1665
1662
|
}
|
|
1666
1663
|
const entries = await readdir(directory, { withFileTypes: true });
|
|
1664
|
+
for (const entry of entries) {
|
|
1665
|
+
if (!entry.isFile()) continue;
|
|
1666
|
+
const lower = entry.name.toLowerCase();
|
|
1667
|
+
if (lower.endsWith(".meta.json") || lower.endsWith(".meta.jsonc")) {
|
|
1668
|
+
diagnostics.push(
|
|
1669
|
+
errorDiagnostic5(
|
|
1670
|
+
"CFG001",
|
|
1671
|
+
`Legacy fixture sidecar "${entry.name}" is not supported. Put meta and data in one .json or .jsonc file.`,
|
|
1672
|
+
{ templateId: emailId, source: { file: path6.join(directory, entry.name) } }
|
|
1673
|
+
)
|
|
1674
|
+
);
|
|
1675
|
+
}
|
|
1676
|
+
}
|
|
1667
1677
|
const payloads = entries.filter((entry) => entry.isFile() && isPayloadFile(entry.name));
|
|
1668
1678
|
const byId = /* @__PURE__ */ new Map();
|
|
1669
1679
|
for (const entry of payloads) {
|
|
@@ -1687,7 +1697,6 @@ async function readFixtures(configDir, emailId, fixturesRelative, diagnostics) {
|
|
|
1687
1697
|
}
|
|
1688
1698
|
const name = names[0];
|
|
1689
1699
|
const file = path6.join(directory, name);
|
|
1690
|
-
const metaFile = path6.join(directory, `${id}.meta.json`);
|
|
1691
1700
|
const parsed2 = await parseFixtureFile(file);
|
|
1692
1701
|
if (!parsed2.ok) {
|
|
1693
1702
|
diagnostics.push({
|
|
@@ -1697,32 +1706,19 @@ async function readFixtures(configDir, emailId, fixturesRelative, diagnostics) {
|
|
|
1697
1706
|
});
|
|
1698
1707
|
continue;
|
|
1699
1708
|
}
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
metaRaw = JSON.parse(await readFile2(metaFile, "utf8"));
|
|
1703
|
-
} catch (error) {
|
|
1704
|
-
const message = error instanceof Error ? error.message : `Failed to read fixture meta ${id}.`;
|
|
1705
|
-
diagnostics.push(
|
|
1706
|
-
errorDiagnostic5("CFG001", message, {
|
|
1707
|
-
templateId: emailId,
|
|
1708
|
-
fixtureId: id,
|
|
1709
|
-
source: { file: metaFile }
|
|
1710
|
-
})
|
|
1711
|
-
);
|
|
1712
|
-
continue;
|
|
1713
|
-
}
|
|
1714
|
-
const meta = parseMeta(metaRaw);
|
|
1715
|
-
if (!meta) {
|
|
1709
|
+
const envelope = fixtureFileSchema.safeParse(parsed2.data);
|
|
1710
|
+
if (!envelope.success) {
|
|
1716
1711
|
diagnostics.push(
|
|
1717
|
-
errorDiagnostic5("CFG001", `Fixture ${id}
|
|
1712
|
+
errorDiagnostic5("CFG001", `Fixture ${id} must be an object with meta and data.`, {
|
|
1718
1713
|
templateId: emailId,
|
|
1719
1714
|
fixtureId: id,
|
|
1720
|
-
source: { file
|
|
1715
|
+
source: { file }
|
|
1721
1716
|
})
|
|
1722
1717
|
);
|
|
1723
1718
|
continue;
|
|
1724
1719
|
}
|
|
1725
|
-
|
|
1720
|
+
const meta = envelope.data.meta;
|
|
1721
|
+
fixtures.push({ id, file, data: envelope.data.data, meta, negative: meta.expect === "invalid" });
|
|
1726
1722
|
}
|
|
1727
1723
|
return fixtures;
|
|
1728
1724
|
}
|
|
@@ -1796,26 +1792,6 @@ async function parseFixtureFile(file) {
|
|
|
1796
1792
|
};
|
|
1797
1793
|
}
|
|
1798
1794
|
}
|
|
1799
|
-
function parseMeta(value) {
|
|
1800
|
-
if (!value || typeof value !== "object" || Array.isArray(value)) return null;
|
|
1801
|
-
const record = value;
|
|
1802
|
-
const allowed = /* @__PURE__ */ new Set(["description", "origin", "event", "purpose", "expectedLocale", "expect"]);
|
|
1803
|
-
if (Object.keys(record).some((key) => !allowed.has(key))) return null;
|
|
1804
|
-
if (typeof record.description !== "string" || typeof record.origin !== "string" || typeof record.event !== "string" || typeof record.purpose !== "string") {
|
|
1805
|
-
return null;
|
|
1806
|
-
}
|
|
1807
|
-
if (record.expectedLocale !== void 0 && typeof record.expectedLocale !== "string") return null;
|
|
1808
|
-
const expect = record.expect ?? "valid";
|
|
1809
|
-
if (expect !== "valid" && expect !== "invalid") return null;
|
|
1810
|
-
return {
|
|
1811
|
-
description: record.description,
|
|
1812
|
-
origin: record.origin,
|
|
1813
|
-
event: record.event,
|
|
1814
|
-
purpose: record.purpose,
|
|
1815
|
-
expect,
|
|
1816
|
-
...typeof record.expectedLocale === "string" ? { expectedLocale: record.expectedLocale } : {}
|
|
1817
|
-
};
|
|
1818
|
-
}
|
|
1819
1795
|
function offsetToPosition(text, offset) {
|
|
1820
1796
|
let line2 = 1;
|
|
1821
1797
|
let column = 1;
|
|
@@ -2312,21 +2288,6 @@ function duplicateId(ids) {
|
|
|
2312
2288
|
}
|
|
2313
2289
|
return null;
|
|
2314
2290
|
}
|
|
2315
|
-
function readProfile(module) {
|
|
2316
|
-
const candidate = module.profile ?? module.default;
|
|
2317
|
-
if (!candidate || typeof candidate !== "object") return null;
|
|
2318
|
-
const value = candidate;
|
|
2319
|
-
if (typeof value.id !== "string" || typeof value.allowParentSegments !== "boolean" || !Array.isArray(value.capabilities))
|
|
2320
|
-
return null;
|
|
2321
|
-
return {
|
|
2322
|
-
emission: {
|
|
2323
|
-
id: value.id,
|
|
2324
|
-
allowParentSegments: value.allowParentSegments,
|
|
2325
|
-
capabilities: value.capabilities
|
|
2326
|
-
},
|
|
2327
|
-
simulator: { helpers: Array.isArray(value.helpers) ? value.helpers : [] }
|
|
2328
|
-
};
|
|
2329
|
-
}
|
|
2330
2291
|
async function discoverFiles(config) {
|
|
2331
2292
|
const found = /* @__PURE__ */ new Set();
|
|
2332
2293
|
for (const pattern of config.emails) {
|
|
@@ -2623,16 +2584,14 @@ async function compileProject(config, profile, emails) {
|
|
|
2623
2584
|
return { ok: true, exitCode: exitOk, diagnostics, manifest, emails: built, wrote: [], preserved: [] };
|
|
2624
2585
|
}
|
|
2625
2586
|
async function prepareResolved(config, onlyId) {
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
if (!profile)
|
|
2635
|
-
return { ok: false, result: emptyProject(exitUsage, [errorDiagnostic10("CFG001", "The target profile is invalid.")]) };
|
|
2587
|
+
const profile = {
|
|
2588
|
+
emission: {
|
|
2589
|
+
id: p0Profile.id,
|
|
2590
|
+
allowParentSegments: p0Profile.allowParentSegments,
|
|
2591
|
+
capabilities: p0Profile.capabilities
|
|
2592
|
+
},
|
|
2593
|
+
simulator: { helpers: p0Profile.helpers }
|
|
2594
|
+
};
|
|
2636
2595
|
const discovered = await discoverEmails(config);
|
|
2637
2596
|
if (!discovered.ok) return { ok: false, result: emptyProject(exitUsage, discovered.diagnostics) };
|
|
2638
2597
|
const selected = onlyId ? discovered.emails.filter((email) => email.definition.id === onlyId) : discovered.emails;
|
package/dist/config/config.d.ts
CHANGED
|
@@ -6,9 +6,6 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
6
6
|
outDir: z.ZodString;
|
|
7
7
|
fixturesDir: z.ZodOptional<z.ZodString>;
|
|
8
8
|
schemasDir: z.ZodOptional<z.ZodString>;
|
|
9
|
-
target: z.ZodObject<{
|
|
10
|
-
profile: z.ZodString;
|
|
11
|
-
}, z.core.$strict>;
|
|
12
9
|
i18n: z.ZodObject<{
|
|
13
10
|
locales: z.ZodArray<z.ZodString>;
|
|
14
11
|
defaultLocale: z.ZodString;
|
|
@@ -47,7 +44,6 @@ export interface ResolvedConfig {
|
|
|
47
44
|
fixturesDir: string;
|
|
48
45
|
schemasDir: string;
|
|
49
46
|
localePath: string | null;
|
|
50
|
-
profilePath: string;
|
|
51
47
|
locales: string[];
|
|
52
48
|
defaultLocale: string;
|
|
53
49
|
catalogs: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAqBvB,QAAA,MAAM,YAAY
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAqBvB,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAmChB,CAAA;AAEF,MAAM,WAAW,aAAc,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAEtE,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAA;IACvC,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,GAAG,SAAS,CAAA;QAChC,oBAAoB,EAAE,OAAO,GAAG,SAAS,CAAA;QACzC,gBAAgB,EAAE,OAAO,CAAA;KAC1B,CAAA;IACD,aAAa,EAAE;QACb,MAAM,EAAE,cAAc,CAAA;QACtB,cAAc,EAAE,MAAM,CAAA;QACtB,iBAAiB,EAAE,MAAM,CAAA;KAC1B,CAAA;IACD,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAElE;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,MAAM,GAChB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,UAAU,EAAE,CAAA;CAAE,CA4CjF;AASD,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAS9F;AAED,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAUpH"}
|
package/dist/index.js
CHANGED
|
@@ -25,9 +25,6 @@ var ConfigSchema = z.strictObject({
|
|
|
25
25
|
outDir: z.string().min(1),
|
|
26
26
|
fixturesDir: z.string().min(1).optional(),
|
|
27
27
|
schemasDir: z.string().min(1).optional(),
|
|
28
|
-
target: z.strictObject({
|
|
29
|
-
profile: z.string().min(1)
|
|
30
|
-
}),
|
|
31
28
|
i18n: z.strictObject({
|
|
32
29
|
locales: z.array(z.string().min(1)).min(1),
|
|
33
30
|
defaultLocale: z.string().min(1),
|
|
@@ -91,7 +88,6 @@ function validateConfig(value, configDir) {
|
|
|
91
88
|
fixturesDir,
|
|
92
89
|
schemasDir,
|
|
93
90
|
localePath: parsed.data.i18n.localePath ?? null,
|
|
94
|
-
profilePath: path.resolve(configDir, parsed.data.target.profile),
|
|
95
91
|
locales: parsed.data.i18n.locales,
|
|
96
92
|
defaultLocale: parsed.data.i18n.defaultLocale,
|
|
97
93
|
catalogs: parsed.data.i18n.catalogs,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build-project.d.ts","sourceRoot":"","sources":["../../src/project/build-project.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"build-project.d.ts","sourceRoot":"","sources":["../../src/project/build-project.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAMtD,OAAO,EAML,KAAK,aAAa,EAEnB,MAAM,SAAS,CAAA;AAGhB,wBAAsB,YAAY,CAAC,KAAK,EAAE;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,GAAG,OAAO,CAAC,aAAa,CAAC,CAIzB;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,GAAG,OAAO,CAAC,aAAa,CAAC,CAEzB;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE;IACL,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,GACA,OAAO,CAAC,aAAa,CAAC,CAkBxB"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Diagnostic } from '@vtex-email/core';
|
|
2
2
|
import type { ResolvedConfig } from '../config/config';
|
|
3
|
-
import type {
|
|
3
|
+
import type { ResolvedEmail } from './types';
|
|
4
4
|
export declare function discoverEmails(config: ResolvedConfig): Promise<{
|
|
5
5
|
ok: true;
|
|
6
6
|
emails: ResolvedEmail[];
|
|
@@ -11,5 +11,4 @@ export declare function discoverEmails(config: ResolvedConfig): Promise<{
|
|
|
11
11
|
export declare function fileKeyFromPath(file: string): string | null;
|
|
12
12
|
export declare function schemaPathForKey(config: ResolvedConfig, fileKey: string): string;
|
|
13
13
|
export declare function duplicateId(ids: readonly string[]): string | null;
|
|
14
|
-
export declare function readProfile(module: Record<string, unknown>): LoadedProfile | null;
|
|
15
14
|
//# sourceMappingURL=discover.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../src/project/discover.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,KAAK,UAAU,
|
|
1
|
+
{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../src/project/discover.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,KAAK,UAAU,EAGhB,MAAM,kBAAkB,CAAA;AAIzB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAO5C,wBAAsB,cAAc,CAClC,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,aAAa,EAAE,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,UAAU,EAAE,CAAA;CAAE,CAAC,CAoE3F;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI3D;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAEhF;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAOjE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../src/project/fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAElC,OAAO,
|
|
1
|
+
{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../src/project/fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAElC,OAAO,EAAoD,KAAK,UAAU,EAAoB,MAAM,kBAAkB,CAAA;AAKtH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAI5C,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,UAAU,EAAE,GACxB,OAAO,CAAC,aAAa,EAAE,CAAC,CA2E1B;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,SAAS,aAAa,EAAE,GACjC,UAAU,EAAE,CAqBd;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAInD;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAM7D"}
|
package/dist/project/types.d.ts
CHANGED
|
@@ -1,17 +1,10 @@
|
|
|
1
|
-
import type { Diagnostic, EmailDefinition, EmissionProfile, LocalSimulator, ScopeNode } from '@vtex-email/core';
|
|
1
|
+
import type { Diagnostic, EmailDefinition, EmissionProfile, FixtureMeta, LocalSimulator, ScopeNode } from '@vtex-email/core';
|
|
2
2
|
import type { BuildManifest } from '@vtex-email/react';
|
|
3
3
|
import type { ZodType } from 'zod';
|
|
4
|
+
export type { FixtureMeta };
|
|
4
5
|
export declare const exitOk = 0;
|
|
5
6
|
export declare const exitValidation = 1;
|
|
6
7
|
export declare const exitUsage = 2;
|
|
7
|
-
export interface FixtureMeta {
|
|
8
|
-
description: string;
|
|
9
|
-
origin: string;
|
|
10
|
-
event: string;
|
|
11
|
-
purpose: string;
|
|
12
|
-
expectedLocale?: string;
|
|
13
|
-
expect: 'valid' | 'invalid';
|
|
14
|
-
}
|
|
15
8
|
export interface LoadedFixture {
|
|
16
9
|
id: string;
|
|
17
10
|
file: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/project/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/project/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,eAAe,EACf,eAAe,EACf,WAAW,EACX,cAAc,EACd,SAAS,EACV,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAElC,YAAY,EAAE,WAAW,EAAE,CAAA;AAE3B,eAAO,MAAM,MAAM,IAAI,CAAA;AACvB,eAAO,MAAM,cAAc,IAAI,CAAA;AAC/B,eAAO,MAAM,SAAS,IAAI,CAAA;AAE1B,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,eAAe,CAAA;IACzB,SAAS,EAAE,cAAc,CAAA;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,YAAY,GAAG,QAAQ,CAAA;IAC/B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,SAAS,EAAE,SAAS,EAAE,CAAA;IACtB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,EAAE,aAAa,EAAE,CAAA;IACzB,eAAe,EAAE,MAAM,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAA;IAC9B,OAAO,EAAE,aAAa,CAAA;IACtB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,CAAC,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,cAAc,CAAA;IAC5B,MAAM,EAAE,KAAK,CAAC;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,YAAY,GAAG,QAAQ,CAAA;QAC/B,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,aAAa,EAAE,MAAM,CAAA;QACrB,KAAK,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;QAC1F,YAAY,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;QACvD,QAAQ,EAAE,MAAM,EAAE,CAAA;KACnB,CAAC,CAAA;CACH;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACnB,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAA;IAChC,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,eAAe,CAAC,MAAM,OAAO,CAAC,CAAA;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,YAAY,GAAG,QAAQ,CAAA;IAC/B,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACjD,WAAW,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,gBAAgB,EAAE,OAAO,CAAA;IACzB,oBAAoB,EAAE,OAAO,GAAG,SAAS,CAAA;CAC1C;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,aAAa,CAEtF"}
|
package/dist/project.js
CHANGED
|
@@ -63,9 +63,6 @@ var ConfigSchema = z.strictObject({
|
|
|
63
63
|
outDir: z.string().min(1),
|
|
64
64
|
fixturesDir: z.string().min(1).optional(),
|
|
65
65
|
schemasDir: z.string().min(1).optional(),
|
|
66
|
-
target: z.strictObject({
|
|
67
|
-
profile: z.string().min(1)
|
|
68
|
-
}),
|
|
69
66
|
i18n: z.strictObject({
|
|
70
67
|
locales: z.array(z.string().min(1)).min(1),
|
|
71
68
|
defaultLocale: z.string().min(1),
|
|
@@ -126,7 +123,6 @@ function validateConfig(value, configDir) {
|
|
|
126
123
|
fixturesDir,
|
|
127
124
|
schemasDir,
|
|
128
125
|
localePath: parsed.data.i18n.localePath ?? null,
|
|
129
|
-
profilePath: path2.resolve(configDir, parsed.data.target.profile),
|
|
130
126
|
locales: parsed.data.i18n.locales,
|
|
131
127
|
defaultLocale: parsed.data.i18n.defaultLocale,
|
|
132
128
|
catalogs: parsed.data.i18n.catalogs,
|
|
@@ -330,6 +326,7 @@ async function loadProjectConfig(configPath) {
|
|
|
330
326
|
|
|
331
327
|
// src/project/build-project.ts
|
|
332
328
|
import { errorDiagnostic as errorDiagnostic10, syntaxHelperNames as syntaxHelperNames2 } from "@vtex-email/core";
|
|
329
|
+
import { p0Profile } from "@vtex-email/vtex";
|
|
333
330
|
|
|
334
331
|
// src/project/compile-email.ts
|
|
335
332
|
import {
|
|
@@ -370,7 +367,7 @@ function isFlatCatalog(value) {
|
|
|
370
367
|
}
|
|
371
368
|
|
|
372
369
|
// src/project/fixtures.ts
|
|
373
|
-
import { checkFixture, errorDiagnostic as errorDiagnostic5 } from "@vtex-email/core";
|
|
370
|
+
import { checkFixture, errorDiagnostic as errorDiagnostic5, fixtureFileSchema } from "@vtex-email/core";
|
|
374
371
|
|
|
375
372
|
// ../../node_modules/.pnpm/jsonc-parser@3.3.1/node_modules/jsonc-parser/lib/esm/impl/scanner.js
|
|
376
373
|
function createScanner(text, ignoreTrivia = false) {
|
|
@@ -1284,6 +1281,19 @@ async function readFixtures(configDir, emailId, fixturesRelative, diagnostics) {
|
|
|
1284
1281
|
return [];
|
|
1285
1282
|
}
|
|
1286
1283
|
const entries = await readdir(directory, { withFileTypes: true });
|
|
1284
|
+
for (const entry of entries) {
|
|
1285
|
+
if (!entry.isFile()) continue;
|
|
1286
|
+
const lower = entry.name.toLowerCase();
|
|
1287
|
+
if (lower.endsWith(".meta.json") || lower.endsWith(".meta.jsonc")) {
|
|
1288
|
+
diagnostics.push(
|
|
1289
|
+
errorDiagnostic5(
|
|
1290
|
+
"CFG001",
|
|
1291
|
+
`Legacy fixture sidecar "${entry.name}" is not supported. Put meta and data in one .json or .jsonc file.`,
|
|
1292
|
+
{ templateId: emailId, source: { file: path6.join(directory, entry.name) } }
|
|
1293
|
+
)
|
|
1294
|
+
);
|
|
1295
|
+
}
|
|
1296
|
+
}
|
|
1287
1297
|
const payloads = entries.filter((entry) => entry.isFile() && isPayloadFile(entry.name));
|
|
1288
1298
|
const byId = /* @__PURE__ */ new Map();
|
|
1289
1299
|
for (const entry of payloads) {
|
|
@@ -1307,7 +1317,6 @@ async function readFixtures(configDir, emailId, fixturesRelative, diagnostics) {
|
|
|
1307
1317
|
}
|
|
1308
1318
|
const name = names[0];
|
|
1309
1319
|
const file = path6.join(directory, name);
|
|
1310
|
-
const metaFile = path6.join(directory, `${id}.meta.json`);
|
|
1311
1320
|
const parsed = await parseFixtureFile(file);
|
|
1312
1321
|
if (!parsed.ok) {
|
|
1313
1322
|
diagnostics.push({
|
|
@@ -1317,32 +1326,19 @@ async function readFixtures(configDir, emailId, fixturesRelative, diagnostics) {
|
|
|
1317
1326
|
});
|
|
1318
1327
|
continue;
|
|
1319
1328
|
}
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
metaRaw = JSON.parse(await readFile2(metaFile, "utf8"));
|
|
1323
|
-
} catch (error) {
|
|
1324
|
-
const message = error instanceof Error ? error.message : `Failed to read fixture meta ${id}.`;
|
|
1325
|
-
diagnostics.push(
|
|
1326
|
-
errorDiagnostic5("CFG001", message, {
|
|
1327
|
-
templateId: emailId,
|
|
1328
|
-
fixtureId: id,
|
|
1329
|
-
source: { file: metaFile }
|
|
1330
|
-
})
|
|
1331
|
-
);
|
|
1332
|
-
continue;
|
|
1333
|
-
}
|
|
1334
|
-
const meta = parseMeta(metaRaw);
|
|
1335
|
-
if (!meta) {
|
|
1329
|
+
const envelope = fixtureFileSchema.safeParse(parsed.data);
|
|
1330
|
+
if (!envelope.success) {
|
|
1336
1331
|
diagnostics.push(
|
|
1337
|
-
errorDiagnostic5("CFG001", `Fixture ${id}
|
|
1332
|
+
errorDiagnostic5("CFG001", `Fixture ${id} must be an object with meta and data.`, {
|
|
1338
1333
|
templateId: emailId,
|
|
1339
1334
|
fixtureId: id,
|
|
1340
|
-
source: { file
|
|
1335
|
+
source: { file }
|
|
1341
1336
|
})
|
|
1342
1337
|
);
|
|
1343
1338
|
continue;
|
|
1344
1339
|
}
|
|
1345
|
-
|
|
1340
|
+
const meta = envelope.data.meta;
|
|
1341
|
+
fixtures.push({ id, file, data: envelope.data.data, meta, negative: meta.expect === "invalid" });
|
|
1346
1342
|
}
|
|
1347
1343
|
return fixtures;
|
|
1348
1344
|
}
|
|
@@ -1416,26 +1412,6 @@ async function parseFixtureFile(file) {
|
|
|
1416
1412
|
};
|
|
1417
1413
|
}
|
|
1418
1414
|
}
|
|
1419
|
-
function parseMeta(value) {
|
|
1420
|
-
if (!value || typeof value !== "object" || Array.isArray(value)) return null;
|
|
1421
|
-
const record = value;
|
|
1422
|
-
const allowed = /* @__PURE__ */ new Set(["description", "origin", "event", "purpose", "expectedLocale", "expect"]);
|
|
1423
|
-
if (Object.keys(record).some((key) => !allowed.has(key))) return null;
|
|
1424
|
-
if (typeof record.description !== "string" || typeof record.origin !== "string" || typeof record.event !== "string" || typeof record.purpose !== "string") {
|
|
1425
|
-
return null;
|
|
1426
|
-
}
|
|
1427
|
-
if (record.expectedLocale !== void 0 && typeof record.expectedLocale !== "string") return null;
|
|
1428
|
-
const expect = record.expect ?? "valid";
|
|
1429
|
-
if (expect !== "valid" && expect !== "invalid") return null;
|
|
1430
|
-
return {
|
|
1431
|
-
description: record.description,
|
|
1432
|
-
origin: record.origin,
|
|
1433
|
-
event: record.event,
|
|
1434
|
-
purpose: record.purpose,
|
|
1435
|
-
expect,
|
|
1436
|
-
...typeof record.expectedLocale === "string" ? { expectedLocale: record.expectedLocale } : {}
|
|
1437
|
-
};
|
|
1438
|
-
}
|
|
1439
1415
|
function offsetToPosition(text, offset) {
|
|
1440
1416
|
let line = 1;
|
|
1441
1417
|
let column = 1;
|
|
@@ -1932,21 +1908,6 @@ function duplicateId(ids) {
|
|
|
1932
1908
|
}
|
|
1933
1909
|
return null;
|
|
1934
1910
|
}
|
|
1935
|
-
function readProfile(module) {
|
|
1936
|
-
const candidate = module.profile ?? module.default;
|
|
1937
|
-
if (!candidate || typeof candidate !== "object") return null;
|
|
1938
|
-
const value = candidate;
|
|
1939
|
-
if (typeof value.id !== "string" || typeof value.allowParentSegments !== "boolean" || !Array.isArray(value.capabilities))
|
|
1940
|
-
return null;
|
|
1941
|
-
return {
|
|
1942
|
-
emission: {
|
|
1943
|
-
id: value.id,
|
|
1944
|
-
allowParentSegments: value.allowParentSegments,
|
|
1945
|
-
capabilities: value.capabilities
|
|
1946
|
-
},
|
|
1947
|
-
simulator: { helpers: Array.isArray(value.helpers) ? value.helpers : [] }
|
|
1948
|
-
};
|
|
1949
|
-
}
|
|
1950
1911
|
async function discoverFiles(config) {
|
|
1951
1912
|
const found = /* @__PURE__ */ new Set();
|
|
1952
1913
|
for (const pattern of config.emails) {
|
|
@@ -2251,16 +2212,14 @@ async function compileProject(config, profile, emails) {
|
|
|
2251
2212
|
return { ok: true, exitCode: exitOk, diagnostics, manifest, emails: built, wrote: [], preserved: [] };
|
|
2252
2213
|
}
|
|
2253
2214
|
async function prepareResolved(config, onlyId) {
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
if (!profile)
|
|
2263
|
-
return { ok: false, result: emptyProject(exitUsage, [errorDiagnostic10("CFG001", "The target profile is invalid.")]) };
|
|
2215
|
+
const profile = {
|
|
2216
|
+
emission: {
|
|
2217
|
+
id: p0Profile.id,
|
|
2218
|
+
allowParentSegments: p0Profile.allowParentSegments,
|
|
2219
|
+
capabilities: p0Profile.capabilities
|
|
2220
|
+
},
|
|
2221
|
+
simulator: { helpers: p0Profile.helpers }
|
|
2222
|
+
};
|
|
2264
2223
|
const discovered = await discoverEmails(config);
|
|
2265
2224
|
if (!discovered.ok) return { ok: false, result: emptyProject(exitUsage, discovered.diagnostics) };
|
|
2266
2225
|
const selected = onlyId ? discovered.emails.filter((email) => email.definition.id === onlyId) : discovered.emails;
|
package/package.json
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vtex-email/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "git+https://github.com/marcelotk15/vtex-react-email.git"
|
|
7
|
+
},
|
|
4
8
|
"bin": {
|
|
5
9
|
"vtex-email": "./dist/bin.js"
|
|
6
10
|
},
|
|
@@ -22,8 +26,9 @@
|
|
|
22
26
|
},
|
|
23
27
|
"dependencies": {
|
|
24
28
|
"@react-email/components": "1.0.12",
|
|
25
|
-
"@vtex-email/core": "0.
|
|
26
|
-
"@vtex-email/react": "0.
|
|
29
|
+
"@vtex-email/core": "0.2.0",
|
|
30
|
+
"@vtex-email/react": "0.2.0",
|
|
31
|
+
"@vtex-email/vtex": "0.2.0",
|
|
27
32
|
"esbuild": "0.28.2",
|
|
28
33
|
"handlebars": "4.7.9",
|
|
29
34
|
"jsonc-parser": "^3.3.1",
|