@vtex-email/cli 0.0.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.
Files changed (60) hide show
  1. package/dist/bin.d.ts +2 -0
  2. package/dist/bin.d.ts.map +1 -0
  3. package/dist/bin.js +2969 -0
  4. package/dist/commands/args.d.ts +39 -0
  5. package/dist/commands/args.d.ts.map +1 -0
  6. package/dist/commands/dev-notices.d.ts +51 -0
  7. package/dist/commands/dev-notices.d.ts.map +1 -0
  8. package/dist/commands/dev-presenter.d.ts +20 -0
  9. package/dist/commands/dev-presenter.d.ts.map +1 -0
  10. package/dist/commands/dev.d.ts +6 -0
  11. package/dist/commands/dev.d.ts.map +1 -0
  12. package/dist/commands/preview-export.d.ts +8 -0
  13. package/dist/commands/preview-export.d.ts.map +1 -0
  14. package/dist/commands/project-commands.d.ts +9 -0
  15. package/dist/commands/project-commands.d.ts.map +1 -0
  16. package/dist/commands/report.d.ts +40 -0
  17. package/dist/commands/report.d.ts.map +1 -0
  18. package/dist/commands/run.d.ts +3 -0
  19. package/dist/commands/run.d.ts.map +1 -0
  20. package/dist/config/config.d.ts +81 -0
  21. package/dist/config/config.d.ts.map +1 -0
  22. package/dist/config/load-config.d.ts +10 -0
  23. package/dist/config/load-config.d.ts.map +1 -0
  24. package/dist/index.d.ts +2 -0
  25. package/dist/index.d.ts.map +1 -0
  26. package/dist/index.js +126 -0
  27. package/dist/project/build-project.d.ts +21 -0
  28. package/dist/project/build-project.d.ts.map +1 -0
  29. package/dist/project/catalogs.d.ts +4 -0
  30. package/dist/project/catalogs.d.ts.map +1 -0
  31. package/dist/project/compile-email.d.ts +4 -0
  32. package/dist/project/compile-email.d.ts.map +1 -0
  33. package/dist/project/discover.d.ts +15 -0
  34. package/dist/project/discover.d.ts.map +1 -0
  35. package/dist/project/fixtures.d.ts +8 -0
  36. package/dist/project/fixtures.d.ts.map +1 -0
  37. package/dist/project/manifest.d.ts +4 -0
  38. package/dist/project/manifest.d.ts.map +1 -0
  39. package/dist/project/merge-variants.d.ts +17 -0
  40. package/dist/project/merge-variants.d.ts.map +1 -0
  41. package/dist/project/module-loader.d.ts +12 -0
  42. package/dist/project/module-loader.d.ts.map +1 -0
  43. package/dist/project/policy.d.ts +4 -0
  44. package/dist/project/policy.d.ts.map +1 -0
  45. package/dist/project/preview-evaluation.d.ts +26 -0
  46. package/dist/project/preview-evaluation.d.ts.map +1 -0
  47. package/dist/project/revalidate.d.ts +4 -0
  48. package/dist/project/revalidate.d.ts.map +1 -0
  49. package/dist/project/settings.d.ts +9 -0
  50. package/dist/project/settings.d.ts.map +1 -0
  51. package/dist/project/types.d.ts +113 -0
  52. package/dist/project/types.d.ts.map +1 -0
  53. package/dist/project/write-output.d.ts +12 -0
  54. package/dist/project/write-output.d.ts.map +1 -0
  55. package/dist/project-api.d.ts +10 -0
  56. package/dist/project-api.d.ts.map +1 -0
  57. package/dist/project.d.ts +11 -0
  58. package/dist/project.d.ts.map +1 -0
  59. package/dist/project.js +2590 -0
  60. package/package.json +35 -0
@@ -0,0 +1,4 @@
1
+ import type { ResolvedConfig } from '../config/config';
2
+ import type { BuiltEmail } from './types';
3
+ export declare function revalidateEmail(config: ResolvedConfig, email: BuiltEmail): Promise<BuiltEmail>;
4
+ //# sourceMappingURL=revalidate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"revalidate.d.ts","sourceRoot":"","sources":["../../src/project/revalidate.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAiB,MAAM,SAAS,CAAA;AAMxD,wBAAsB,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAkBpG"}
@@ -0,0 +1,9 @@
1
+ import { type Diagnostic, type EmailSettings } from '@vtex-email/core';
2
+ export declare function parseEmailSettings(value: unknown, file: string): {
3
+ ok: true;
4
+ settings: EmailSettings;
5
+ } | {
6
+ ok: false;
7
+ diagnostics: Diagnostic[];
8
+ };
9
+ //# sourceMappingURL=settings.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/project/settings.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,KAAK,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAKvF,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,MAAM,GACX;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,aAAa,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,UAAU,EAAE,CAAA;CAAE,CA+ClF"}
@@ -0,0 +1,113 @@
1
+ import type { Diagnostic, EmailDefinition, EmissionProfile, LocalSimulator, ScopeNode } from '@vtex-email/core';
2
+ import type { BuildManifest } from '@vtex-email/react';
3
+ import type { ZodType } from 'zod';
4
+ export declare const exitOk = 0;
5
+ export declare const exitValidation = 1;
6
+ 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
+ export interface LoadedFixture {
16
+ id: string;
17
+ file: string;
18
+ data: unknown;
19
+ meta: FixtureMeta;
20
+ negative: boolean;
21
+ }
22
+ export interface BuiltFile {
23
+ name: string;
24
+ content: string;
25
+ sha256: string;
26
+ role: 'locale' | 'merged';
27
+ locale?: string;
28
+ }
29
+ export interface LoadedProfile {
30
+ emission: EmissionProfile;
31
+ simulator: LocalSimulator;
32
+ }
33
+ export interface BuiltEmail {
34
+ id: string;
35
+ event: string;
36
+ output: 'per-locale' | 'merged';
37
+ locales: string[];
38
+ defaultLocale: string;
39
+ localePath: string;
40
+ files: BuiltFile[];
41
+ diagnostics: Diagnostic[];
42
+ structure: ScopeNode[];
43
+ dependencies: string[];
44
+ fixtures: LoadedFixture[];
45
+ fixturesPattern: string;
46
+ file: string;
47
+ schema: ZodType;
48
+ manifest: BuildManifest | null;
49
+ profile: LoadedProfile;
50
+ warnRenderedBytes: number;
51
+ }
52
+ export interface ProjectManifest {
53
+ formatVersion: 1;
54
+ profileId: string;
55
+ homologation: 'experimental';
56
+ emails: Array<{
57
+ id: string;
58
+ event: string;
59
+ output: 'per-locale' | 'merged';
60
+ locales: string[];
61
+ defaultLocale: string;
62
+ files: Array<{
63
+ name: string;
64
+ sha256: string;
65
+ role: 'locale' | 'merged';
66
+ locale?: string;
67
+ }>;
68
+ capabilities: Array<{
69
+ name: string;
70
+ evidence: string;
71
+ }>;
72
+ warnings: string[];
73
+ }>;
74
+ }
75
+ export interface ProjectResult {
76
+ ok: boolean;
77
+ exitCode: 0 | 1 | 2;
78
+ diagnostics: Diagnostic[];
79
+ manifest: ProjectManifest | null;
80
+ emails: BuiltEmail[];
81
+ wrote: string[];
82
+ preserved: string[];
83
+ removedEmailIds?: string[];
84
+ }
85
+ export interface PreviewResult {
86
+ ok: boolean;
87
+ exitCode: 0 | 1 | 2;
88
+ html: string;
89
+ source: string;
90
+ diagnostics: Diagnostic[];
91
+ selector: boolean;
92
+ locale: string;
93
+ payloadLocale: string | null;
94
+ }
95
+ export interface ResolvedEmail {
96
+ definition: EmailDefinition<() => unknown>;
97
+ file: string;
98
+ fileKey: string;
99
+ dependencies: string[];
100
+ locales: string[];
101
+ defaultLocale: string;
102
+ localePath: string;
103
+ output: 'per-locale' | 'merged';
104
+ aliases: Array<{
105
+ alias: string;
106
+ locale: string;
107
+ }>;
108
+ unknownPath: 'error' | 'warning';
109
+ warningsAsErrors: boolean;
110
+ unverifiedCapability: 'error' | 'warning';
111
+ }
112
+ export declare function emptyProject(exitCode: 1 | 2, diagnostics: Diagnostic[]): ProjectResult;
113
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/project/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAC/G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAElC,eAAO,MAAM,MAAM,IAAI,CAAA;AACvB,eAAO,MAAM,cAAc,IAAI,CAAA;AAC/B,eAAO,MAAM,SAAS,IAAI,CAAA;AAE1B,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,MAAM,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5B;AAED,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"}
@@ -0,0 +1,12 @@
1
+ import { type Diagnostic } from '@vtex-email/core';
2
+ import type { BuiltEmail, ProjectManifest } from './types';
3
+ export declare function writeOutput(outDir: string, manifest: ProjectManifest, emails: BuiltEmail[], onlyId: string | undefined, helperNames: readonly string[], locale: string | undefined): Promise<{
4
+ ok: true;
5
+ manifest: ProjectManifest;
6
+ wrote: string[];
7
+ preserved: string[];
8
+ } | {
9
+ ok: false;
10
+ diagnostic: Diagnostic;
11
+ }>;
12
+ //# sourceMappingURL=write-output.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"write-output.d.ts","sourceRoot":"","sources":["../../src/project/write-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAIpE,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAI1D,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,eAAe,EACzB,MAAM,EAAE,UAAU,EAAE,EACpB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,WAAW,EAAE,SAAS,MAAM,EAAE,EAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,OAAO,CACR;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,eAAe,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CACtH,CA0CA"}
@@ -0,0 +1,10 @@
1
+ export type { DevIngestPlan, DevNotice, DevNoticeHandler, DevPhase } from './commands/dev-notices';
2
+ export { publishDiagnostics, type CliDiagnostic } from './commands/report';
3
+ export { loadProjectConfig } from './config/load-config';
4
+ export { buildProject, validateProject } from './project/build-project';
5
+ export { duplicateId } from './project/discover';
6
+ export { importBundled } from './project/module-loader';
7
+ export { exportPreview, previewBuiltEmail, refreshEmailFixtures, renderPreview } from './project/preview-evaluation';
8
+ export { revalidateEmail } from './project/revalidate';
9
+ export { exitOk, exitUsage, exitValidation, type BuiltEmail, type BuiltFile, type FixtureMeta, type LoadedFixture, type PreviewResult, type ProjectManifest, type ProjectResult, } from './project/types';
10
+ //# sourceMappingURL=project-api.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"project-api.d.ts","sourceRoot":"","sources":["../src/project-api.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAClG,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACpH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EACL,MAAM,EACN,SAAS,EACT,cAAc,EACd,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,iBAAiB,CAAA"}
@@ -0,0 +1,11 @@
1
+ export type { DevIngestPlan, DevNotice, DevNoticeHandler, DevPhase } from './commands/dev-notices';
2
+ export { publishDiagnostics, type CliDiagnostic } from './commands/report';
3
+ export { type ResolvedConfig } from './config/config';
4
+ export { loadProjectConfig } from './config/load-config';
5
+ export { buildProject, validateProject } from './project/build-project';
6
+ export { duplicateId } from './project/discover';
7
+ export { importBundled } from './project/module-loader';
8
+ export { exportPreview, previewBuiltEmail, refreshEmailFixtures, renderPreview } from './project/preview-evaluation';
9
+ export { revalidateEmail } from './project/revalidate';
10
+ export { exitOk, exitUsage, exitValidation, type BuiltEmail, type BuiltFile, type FixtureMeta, type LoadedFixture, type PreviewResult, type ProjectManifest, type ProjectResult, } from './project/types';
11
+ //# sourceMappingURL=project.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../src/project.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAClG,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACpH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EACL,MAAM,EACN,SAAS,EACT,cAAc,EACd,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,iBAAiB,CAAA"}