prismic 0.0.0-pr.28.59bf330

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 (158) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +69 -0
  3. package/dist/builders-hKD4IrLX-DsO7BUQw.mjs +97 -0
  4. package/dist/dist-B11B2hHn.mjs +1 -0
  5. package/dist/dist-DT8CtumB.mjs +1 -0
  6. package/dist/framework-CfjEoVk0.mjs +17 -0
  7. package/dist/index.mjs +2537 -0
  8. package/dist/nextjs-9z7YrSnS.mjs +312 -0
  9. package/dist/nuxt-KoJ61G2q.mjs +59 -0
  10. package/dist/sveltekit-DjXKCG78.mjs +226 -0
  11. package/package.json +58 -0
  12. package/src/codegen-types.ts +82 -0
  13. package/src/codegen.ts +45 -0
  14. package/src/custom-type-add-field-boolean.ts +185 -0
  15. package/src/custom-type-add-field-color.ts +168 -0
  16. package/src/custom-type-add-field-date.ts +171 -0
  17. package/src/custom-type-add-field-embed.ts +168 -0
  18. package/src/custom-type-add-field-geo-point.ts +165 -0
  19. package/src/custom-type-add-field-group.ts +142 -0
  20. package/src/custom-type-add-field-image.ts +168 -0
  21. package/src/custom-type-add-field-key-text.ts +168 -0
  22. package/src/custom-type-add-field-link.ts +191 -0
  23. package/src/custom-type-add-field-number.ts +200 -0
  24. package/src/custom-type-add-field-rich-text.ts +192 -0
  25. package/src/custom-type-add-field-select.ts +174 -0
  26. package/src/custom-type-add-field-timestamp.ts +171 -0
  27. package/src/custom-type-add-field-uid.ts +151 -0
  28. package/src/custom-type-add-field.ts +116 -0
  29. package/src/custom-type-connect-slice.ts +178 -0
  30. package/src/custom-type-create.ts +98 -0
  31. package/src/custom-type-disconnect-slice.ts +134 -0
  32. package/src/custom-type-list.ts +110 -0
  33. package/src/custom-type-remove-field.ts +135 -0
  34. package/src/custom-type-remove.ts +103 -0
  35. package/src/custom-type-set-name.ts +102 -0
  36. package/src/custom-type-view.ts +118 -0
  37. package/src/custom-type.ts +85 -0
  38. package/src/docs-fetch.ts +146 -0
  39. package/src/docs-list.ts +131 -0
  40. package/src/docs.ts +54 -0
  41. package/src/env.d.ts +12 -0
  42. package/src/framework/index.ts +399 -0
  43. package/src/framework/nextjs.templates.ts +426 -0
  44. package/src/framework/nextjs.ts +216 -0
  45. package/src/framework/nuxt.templates.ts +74 -0
  46. package/src/framework/nuxt.ts +250 -0
  47. package/src/framework/sveltekit.templates.ts +278 -0
  48. package/src/framework/sveltekit.ts +241 -0
  49. package/src/index.ts +155 -0
  50. package/src/init.ts +173 -0
  51. package/src/lib/auth.ts +200 -0
  52. package/src/lib/browser.ts +11 -0
  53. package/src/lib/config.ts +111 -0
  54. package/src/lib/custom-types-api.ts +385 -0
  55. package/src/lib/field-path.ts +81 -0
  56. package/src/lib/file.ts +49 -0
  57. package/src/lib/json.ts +3 -0
  58. package/src/lib/packageJson.ts +35 -0
  59. package/src/lib/profile.ts +39 -0
  60. package/src/lib/request.ts +116 -0
  61. package/src/lib/segment.ts +145 -0
  62. package/src/lib/sentry.ts +63 -0
  63. package/src/lib/string.ts +10 -0
  64. package/src/lib/url.ts +31 -0
  65. package/src/locale-add.ts +116 -0
  66. package/src/locale-list.ts +107 -0
  67. package/src/locale-remove.ts +88 -0
  68. package/src/locale-set-default.ts +131 -0
  69. package/src/locale.ts +60 -0
  70. package/src/login.ts +45 -0
  71. package/src/logout.ts +36 -0
  72. package/src/page-type-add-field-boolean.ts +179 -0
  73. package/src/page-type-add-field-color.ts +165 -0
  74. package/src/page-type-add-field-date.ts +168 -0
  75. package/src/page-type-add-field-embed.ts +165 -0
  76. package/src/page-type-add-field-geo-point.ts +162 -0
  77. package/src/page-type-add-field-group.ts +139 -0
  78. package/src/page-type-add-field-image.ts +165 -0
  79. package/src/page-type-add-field-key-text.ts +165 -0
  80. package/src/page-type-add-field-link.ts +188 -0
  81. package/src/page-type-add-field-number.ts +197 -0
  82. package/src/page-type-add-field-rich-text.ts +189 -0
  83. package/src/page-type-add-field-select.ts +171 -0
  84. package/src/page-type-add-field-timestamp.ts +168 -0
  85. package/src/page-type-add-field-uid.ts +148 -0
  86. package/src/page-type-add-field.ts +116 -0
  87. package/src/page-type-connect-slice.ts +178 -0
  88. package/src/page-type-create.ts +128 -0
  89. package/src/page-type-disconnect-slice.ts +134 -0
  90. package/src/page-type-list.ts +109 -0
  91. package/src/page-type-remove-field.ts +135 -0
  92. package/src/page-type-remove.ts +103 -0
  93. package/src/page-type-set-name.ts +102 -0
  94. package/src/page-type-set-repeatable.ts +111 -0
  95. package/src/page-type-view.ts +118 -0
  96. package/src/page-type.ts +90 -0
  97. package/src/preview-add.ts +126 -0
  98. package/src/preview-get-simulator.ts +104 -0
  99. package/src/preview-list.ts +106 -0
  100. package/src/preview-remove-simulator.ts +80 -0
  101. package/src/preview-remove.ts +109 -0
  102. package/src/preview-set-name.ts +137 -0
  103. package/src/preview-set-simulator.ts +116 -0
  104. package/src/preview.ts +75 -0
  105. package/src/pull.ts +236 -0
  106. package/src/push.ts +409 -0
  107. package/src/repo-create.ts +175 -0
  108. package/src/repo-get-access.ts +86 -0
  109. package/src/repo-list.ts +100 -0
  110. package/src/repo-set-access.ts +100 -0
  111. package/src/repo-set-name.ts +102 -0
  112. package/src/repo-view.ts +113 -0
  113. package/src/repo.ts +70 -0
  114. package/src/slice-add-field-boolean.ts +219 -0
  115. package/src/slice-add-field-color.ts +205 -0
  116. package/src/slice-add-field-date.ts +205 -0
  117. package/src/slice-add-field-embed.ts +205 -0
  118. package/src/slice-add-field-geo-point.ts +202 -0
  119. package/src/slice-add-field-group.ts +170 -0
  120. package/src/slice-add-field-image.ts +202 -0
  121. package/src/slice-add-field-key-text.ts +205 -0
  122. package/src/slice-add-field-link.ts +224 -0
  123. package/src/slice-add-field-number.ts +205 -0
  124. package/src/slice-add-field-rich-text.ts +229 -0
  125. package/src/slice-add-field-select.ts +211 -0
  126. package/src/slice-add-field-timestamp.ts +205 -0
  127. package/src/slice-add-field.ts +111 -0
  128. package/src/slice-add-variation.ts +142 -0
  129. package/src/slice-create.ts +164 -0
  130. package/src/slice-list-variations.ts +71 -0
  131. package/src/slice-list.ts +60 -0
  132. package/src/slice-remove-field.ts +125 -0
  133. package/src/slice-remove-variation.ts +113 -0
  134. package/src/slice-remove.ts +92 -0
  135. package/src/slice-rename.ts +104 -0
  136. package/src/slice-set-screenshot.ts +239 -0
  137. package/src/slice-view.ts +83 -0
  138. package/src/slice.ts +95 -0
  139. package/src/status.ts +834 -0
  140. package/src/sync.ts +259 -0
  141. package/src/token-create.ts +203 -0
  142. package/src/token-delete.ts +182 -0
  143. package/src/token-list.ts +223 -0
  144. package/src/token-set-name.ts +193 -0
  145. package/src/token.ts +60 -0
  146. package/src/webhook-add-header.ts +118 -0
  147. package/src/webhook-create.ts +152 -0
  148. package/src/webhook-disable.ts +109 -0
  149. package/src/webhook-enable.ts +132 -0
  150. package/src/webhook-list.ts +93 -0
  151. package/src/webhook-remove-header.ts +117 -0
  152. package/src/webhook-remove.ts +106 -0
  153. package/src/webhook-set-triggers.ts +148 -0
  154. package/src/webhook-status.ts +90 -0
  155. package/src/webhook-test.ts +106 -0
  156. package/src/webhook-view.ts +147 -0
  157. package/src/webhook.ts +95 -0
  158. package/src/whoami.ts +62 -0
@@ -0,0 +1,168 @@
1
+ import type { CustomType, Embed } from "@prismicio/types-internal/lib/customtypes";
2
+
3
+ import { parseArgs } from "node:util";
4
+
5
+ import { buildTypes } from "./codegen-types";
6
+ import { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
7
+ import { requireFramework } from "./framework";
8
+ import { humanReadable } from "./lib/string";
9
+
10
+ const HELP = `
11
+ Add an embed field to an existing custom type.
12
+
13
+ USAGE
14
+ prismic custom-type add-field embed <type-id> <field-id> [flags]
15
+
16
+ ARGUMENTS
17
+ type-id Custom type identifier (required)
18
+ field-id Field identifier (required)
19
+
20
+ FLAGS
21
+ -t, --tab string Target tab (default: first existing tab, or "Main")
22
+ -l, --label string Display label for the field (inferred from field-id if omitted)
23
+ -p, --placeholder string Placeholder text
24
+ --types string Output file for generated types (default: "prismicio-types.d.ts")
25
+ -h, --help Show help for command
26
+
27
+ EXAMPLES
28
+ prismic custom-type add-field embed homepage video
29
+ prismic custom-type add-field embed homepage youtube --tab "Media"
30
+ prismic custom-type add-field embed homepage media --label "Media Embed"
31
+ `.trim();
32
+
33
+ export async function customTypeAddFieldEmbed(): Promise<void> {
34
+ const {
35
+ values: { help, tab, label, placeholder, types },
36
+ positionals: [typeId, fieldId],
37
+ } = parseArgs({
38
+ args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "embed"
39
+ options: {
40
+ tab: { type: "string", short: "t" },
41
+ label: { type: "string", short: "l" },
42
+ placeholder: { type: "string", short: "p" },
43
+ types: { type: "string" },
44
+ help: { type: "boolean", short: "h" },
45
+ },
46
+ allowPositionals: true,
47
+ });
48
+
49
+ if (help) {
50
+ console.info(HELP);
51
+ return;
52
+ }
53
+
54
+ if (!typeId) {
55
+ console.error("Missing required argument: type-id\n");
56
+ console.error("Usage: prismic custom-type add-field embed <type-id> <field-id>");
57
+ process.exitCode = 1;
58
+ return;
59
+ }
60
+
61
+ if (!fieldId) {
62
+ console.error("Missing required argument: field-id\n");
63
+ console.error("Usage: prismic custom-type add-field embed <type-id> <field-id>");
64
+ process.exitCode = 1;
65
+ return;
66
+ }
67
+
68
+ // Parse and validate field path
69
+ const fieldPath = parseFieldPath(fieldId);
70
+ const pathValidation = validateNestedFieldPath(fieldPath);
71
+ if (!pathValidation.ok) {
72
+ console.error(pathValidation.error);
73
+ process.exitCode = 1;
74
+ return;
75
+ }
76
+
77
+ const framework = await requireFramework();
78
+ if (!framework) return;
79
+
80
+ let model: CustomType;
81
+ try {
82
+ model = await framework.readCustomType(typeId);
83
+ } catch {
84
+ console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
85
+ process.exitCode = 1;
86
+ return;
87
+ }
88
+
89
+ // Determine target tab
90
+ const existingTabs = Object.keys(model.json);
91
+ const targetTab = tab ?? existingTabs[0] ?? "Main";
92
+
93
+ // Initialize tab if it doesn't exist
94
+ if (!model.json[targetTab]) {
95
+ model.json[targetTab] = {};
96
+ }
97
+
98
+ // Build field definition
99
+ const fieldDefinition: Embed = {
100
+ type: "Embed",
101
+ config: {
102
+ label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
103
+ ...(placeholder && { placeholder }),
104
+ },
105
+ };
106
+
107
+ // Add field to model
108
+ if (fieldPath.type === "nested") {
109
+ const groupResult = findGroupInTab(model.json[targetTab], fieldPath.groupId, targetTab);
110
+ if (!groupResult.ok) {
111
+ console.error(groupResult.error);
112
+ process.exitCode = 1;
113
+ return;
114
+ }
115
+ if (groupResult.group.config.fields[fieldPath.nestedFieldId]) {
116
+ console.error(`Field "${fieldPath.nestedFieldId}" already exists in group "${fieldPath.groupId}"`);
117
+ process.exitCode = 1;
118
+ return;
119
+ }
120
+ groupResult.group.config.fields[fieldPath.nestedFieldId] = fieldDefinition;
121
+ } else {
122
+ for (const [tabName, tabFields] of Object.entries(model.json)) {
123
+ if (tabFields[fieldId]) {
124
+ console.error(`Field "${fieldId}" already exists in tab "${tabName}"`);
125
+ process.exitCode = 1;
126
+ return;
127
+ }
128
+ for (const [groupFieldId, groupField] of Object.entries(tabFields)) {
129
+ if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
130
+ console.error(`Field "${fieldId}" already exists in group "${groupFieldId}" in tab "${tabName}"`);
131
+ process.exitCode = 1;
132
+ return;
133
+ }
134
+ }
135
+ }
136
+ model.json[targetTab][fieldId] = fieldDefinition;
137
+ }
138
+
139
+ // Write updated model
140
+ try {
141
+ await framework.updateCustomType(model);
142
+ } catch (error) {
143
+ if (error instanceof Error) {
144
+ console.error(`Failed to update custom type: ${error.message}`);
145
+ } else {
146
+ console.error("Failed to update custom type");
147
+ }
148
+ process.exitCode = 1;
149
+ return;
150
+ }
151
+
152
+ if (fieldPath.type === "nested") {
153
+ console.info(`Added field "${fieldPath.nestedFieldId}" (Embed) to group "${fieldPath.groupId}" in ${typeId}`);
154
+ } else {
155
+ console.info(`Added field "${fieldId}" (Embed) to "${targetTab}" tab in ${typeId}`);
156
+ }
157
+
158
+ try {
159
+ await buildTypes({ output: types });
160
+ console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
161
+ } catch (error) {
162
+ console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
163
+ }
164
+
165
+ console.info();
166
+ console.info("Next: Add more fields with `prismic custom-type add-field`");
167
+ console.info(" Run `prismic status` when done to find next steps");
168
+ }
@@ -0,0 +1,165 @@
1
+ import type { CustomType, GeoPoint } from "@prismicio/types-internal/lib/customtypes";
2
+
3
+ import { parseArgs } from "node:util";
4
+
5
+ import { buildTypes } from "./codegen-types";
6
+ import { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
7
+ import { requireFramework } from "./framework";
8
+ import { humanReadable } from "./lib/string";
9
+
10
+ const HELP = `
11
+ Add a geo-point (location) field to an existing custom type.
12
+
13
+ USAGE
14
+ prismic custom-type add-field geo-point <type-id> <field-id> [flags]
15
+
16
+ ARGUMENTS
17
+ type-id Custom type identifier (required)
18
+ field-id Field identifier (required)
19
+
20
+ FLAGS
21
+ -t, --tab string Target tab (default: first existing tab, or "Main")
22
+ -l, --label string Display label for the field (inferred from field-id if omitted)
23
+ --types string Output file for generated types (default: "prismicio-types.d.ts")
24
+ -h, --help Show help for command
25
+
26
+ EXAMPLES
27
+ prismic custom-type add-field geo-point homepage location
28
+ prismic custom-type add-field geo-point store address --tab "Details"
29
+ prismic custom-type add-field geo-point event venue --label "Event Venue"
30
+ `.trim();
31
+
32
+ export async function customTypeAddFieldGeoPoint(): Promise<void> {
33
+ const {
34
+ values: { help, tab, label, types },
35
+ positionals: [typeId, fieldId],
36
+ } = parseArgs({
37
+ args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "geo-point"
38
+ options: {
39
+ tab: { type: "string", short: "t" },
40
+ label: { type: "string", short: "l" },
41
+ types: { type: "string" },
42
+ help: { type: "boolean", short: "h" },
43
+ },
44
+ allowPositionals: true,
45
+ });
46
+
47
+ if (help) {
48
+ console.info(HELP);
49
+ return;
50
+ }
51
+
52
+ if (!typeId) {
53
+ console.error("Missing required argument: type-id\n");
54
+ console.error("Usage: prismic custom-type add-field geo-point <type-id> <field-id>");
55
+ process.exitCode = 1;
56
+ return;
57
+ }
58
+
59
+ if (!fieldId) {
60
+ console.error("Missing required argument: field-id\n");
61
+ console.error("Usage: prismic custom-type add-field geo-point <type-id> <field-id>");
62
+ process.exitCode = 1;
63
+ return;
64
+ }
65
+
66
+ // Parse and validate field path
67
+ const fieldPath = parseFieldPath(fieldId);
68
+ const pathValidation = validateNestedFieldPath(fieldPath);
69
+ if (!pathValidation.ok) {
70
+ console.error(pathValidation.error);
71
+ process.exitCode = 1;
72
+ return;
73
+ }
74
+
75
+ const framework = await requireFramework();
76
+ if (!framework) return;
77
+
78
+ let model: CustomType;
79
+ try {
80
+ model = await framework.readCustomType(typeId);
81
+ } catch {
82
+ console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
83
+ process.exitCode = 1;
84
+ return;
85
+ }
86
+
87
+ // Determine target tab
88
+ const existingTabs = Object.keys(model.json);
89
+ const targetTab = tab ?? existingTabs[0] ?? "Main";
90
+
91
+ // Initialize tab if it doesn't exist
92
+ if (!model.json[targetTab]) {
93
+ model.json[targetTab] = {};
94
+ }
95
+
96
+ // Build field definition
97
+ const fieldDefinition: GeoPoint = {
98
+ type: "GeoPoint",
99
+ config: {
100
+ label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
101
+ },
102
+ };
103
+
104
+ // Add field to model
105
+ if (fieldPath.type === "nested") {
106
+ const groupResult = findGroupInTab(model.json[targetTab], fieldPath.groupId, targetTab);
107
+ if (!groupResult.ok) {
108
+ console.error(groupResult.error);
109
+ process.exitCode = 1;
110
+ return;
111
+ }
112
+ if (groupResult.group.config.fields[fieldPath.nestedFieldId]) {
113
+ console.error(`Field "${fieldPath.nestedFieldId}" already exists in group "${fieldPath.groupId}"`);
114
+ process.exitCode = 1;
115
+ return;
116
+ }
117
+ groupResult.group.config.fields[fieldPath.nestedFieldId] = fieldDefinition;
118
+ } else {
119
+ for (const [tabName, tabFields] of Object.entries(model.json)) {
120
+ if (tabFields[fieldId]) {
121
+ console.error(`Field "${fieldId}" already exists in tab "${tabName}"`);
122
+ process.exitCode = 1;
123
+ return;
124
+ }
125
+ for (const [groupFieldId, groupField] of Object.entries(tabFields)) {
126
+ if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
127
+ console.error(`Field "${fieldId}" already exists in group "${groupFieldId}" in tab "${tabName}"`);
128
+ process.exitCode = 1;
129
+ return;
130
+ }
131
+ }
132
+ }
133
+ model.json[targetTab][fieldId] = fieldDefinition;
134
+ }
135
+
136
+ // Write updated model
137
+ try {
138
+ await framework.updateCustomType(model);
139
+ } catch (error) {
140
+ if (error instanceof Error) {
141
+ console.error(`Failed to update custom type: ${error.message}`);
142
+ } else {
143
+ console.error("Failed to update custom type");
144
+ }
145
+ process.exitCode = 1;
146
+ return;
147
+ }
148
+
149
+ if (fieldPath.type === "nested") {
150
+ console.info(`Added field "${fieldPath.nestedFieldId}" (GeoPoint) to group "${fieldPath.groupId}" in ${typeId}`);
151
+ } else {
152
+ console.info(`Added field "${fieldId}" (GeoPoint) to "${targetTab}" tab in ${typeId}`);
153
+ }
154
+
155
+ try {
156
+ await buildTypes({ output: types });
157
+ console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
158
+ } catch (error) {
159
+ console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
160
+ }
161
+
162
+ console.info();
163
+ console.info("Next: Add more fields with `prismic custom-type add-field`");
164
+ console.info(" Run `prismic status` when done to find next steps");
165
+ }
@@ -0,0 +1,142 @@
1
+ import type { CustomType, Group } from "@prismicio/types-internal/lib/customtypes";
2
+
3
+ import { parseArgs } from "node:util";
4
+
5
+ import { buildTypes } from "./codegen-types";
6
+ import { requireFramework } from "./framework";
7
+ import { humanReadable } from "./lib/string";
8
+
9
+ const HELP = `
10
+ Add a group field to an existing custom type.
11
+
12
+ USAGE
13
+ prismic custom-type add-field group <type-id> <field-id> [flags]
14
+
15
+ ARGUMENTS
16
+ type-id Custom type identifier (required)
17
+ field-id Field identifier (required)
18
+
19
+ FLAGS
20
+ -t, --tab string Target tab (default: first existing tab, or "Main")
21
+ -l, --label string Display label for the field (inferred from field-id if omitted)
22
+ --non-repeatable Make this a non-repeating group (default: repeatable)
23
+ --types string Output file for generated types (default: "prismicio-types.d.ts")
24
+ -h, --help Show help for command
25
+
26
+ EXAMPLES
27
+ prismic custom-type add-field group homepage buttons
28
+ prismic custom-type add-field group article authors --non-repeatable
29
+ prismic custom-type add-field group product variants --tab "Content"
30
+ `.trim();
31
+
32
+ export async function customTypeAddFieldGroup(): Promise<void> {
33
+ const {
34
+ values: { help, tab, label, "non-repeatable": nonRepeatable, types },
35
+ positionals: [typeId, fieldId],
36
+ } = parseArgs({
37
+ args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "group"
38
+ options: {
39
+ tab: { type: "string", short: "t" },
40
+ label: { type: "string", short: "l" },
41
+ "non-repeatable": { type: "boolean" },
42
+ types: { type: "string" },
43
+ help: { type: "boolean", short: "h" },
44
+ },
45
+ allowPositionals: true,
46
+ });
47
+
48
+ if (help) {
49
+ console.info(HELP);
50
+ return;
51
+ }
52
+
53
+ if (!typeId) {
54
+ console.error("Missing required argument: type-id\n");
55
+ console.error("Usage: prismic custom-type add-field group <type-id> <field-id>");
56
+ process.exitCode = 1;
57
+ return;
58
+ }
59
+
60
+ if (!fieldId) {
61
+ console.error("Missing required argument: field-id\n");
62
+ console.error("Usage: prismic custom-type add-field group <type-id> <field-id>");
63
+ process.exitCode = 1;
64
+ return;
65
+ }
66
+
67
+ // Groups cannot be nested
68
+ if (fieldId.includes(".")) {
69
+ console.error("Groups cannot be nested inside other groups");
70
+ process.exitCode = 1;
71
+ return;
72
+ }
73
+
74
+ const framework = await requireFramework();
75
+ if (!framework) return;
76
+
77
+ let model: CustomType;
78
+ try {
79
+ model = await framework.readCustomType(typeId);
80
+ } catch {
81
+ console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
82
+ process.exitCode = 1;
83
+ return;
84
+ }
85
+
86
+ // Determine target tab
87
+ const existingTabs = Object.keys(model.json);
88
+ const targetTab = tab ?? existingTabs[0] ?? "Main";
89
+
90
+ // Initialize tab if it doesn't exist
91
+ if (!model.json[targetTab]) {
92
+ model.json[targetTab] = {};
93
+ }
94
+
95
+ // Check if field already exists in any tab
96
+ for (const [tabName, tabFields] of Object.entries(model.json)) {
97
+ if (tabFields[fieldId]) {
98
+ console.error(`Field "${fieldId}" already exists in tab "${tabName}"`);
99
+ process.exitCode = 1;
100
+ return;
101
+ }
102
+ }
103
+
104
+ // Build field definition
105
+ const fieldDefinition: Group = {
106
+ type: "Group",
107
+ config: {
108
+ label: label ?? humanReadable(fieldId),
109
+ repeat: !nonRepeatable,
110
+ fields: {},
111
+ },
112
+ };
113
+
114
+ // Add field to model
115
+ model.json[targetTab][fieldId] = fieldDefinition;
116
+
117
+ // Write updated model
118
+ try {
119
+ await framework.updateCustomType(model);
120
+ } catch (error) {
121
+ if (error instanceof Error) {
122
+ console.error(`Failed to update custom type: ${error.message}`);
123
+ } else {
124
+ console.error("Failed to update custom type");
125
+ }
126
+ process.exitCode = 1;
127
+ return;
128
+ }
129
+
130
+ console.info(`Added field "${fieldId}" (Group) to "${targetTab}" tab in ${typeId}`);
131
+
132
+ try {
133
+ await buildTypes({ output: types });
134
+ console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
135
+ } catch (error) {
136
+ console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
137
+ }
138
+
139
+ console.info();
140
+ console.info(`Next: Add fields to the group with \`prismic custom-type add-field <type> ${typeId} ${fieldId}.<field-id>\``);
141
+ console.info(" Run `prismic status` when done to find next steps");
142
+ }
@@ -0,0 +1,168 @@
1
+ import type { CustomType, Image } from "@prismicio/types-internal/lib/customtypes";
2
+
3
+ import { parseArgs } from "node:util";
4
+
5
+ import { buildTypes } from "./codegen-types";
6
+ import { findGroupInTab, isGroupField, parseFieldPath, validateNestedFieldPath } from "./lib/field-path";
7
+ import { requireFramework } from "./framework";
8
+ import { humanReadable } from "./lib/string";
9
+
10
+ const HELP = `
11
+ Add an image field to an existing custom type.
12
+
13
+ USAGE
14
+ prismic custom-type add-field image <type-id> <field-id> [flags]
15
+
16
+ ARGUMENTS
17
+ type-id Custom type identifier (required)
18
+ field-id Field identifier (required)
19
+
20
+ FLAGS
21
+ -t, --tab string Target tab (default: first existing tab, or "Main")
22
+ -l, --label string Display label for the field (inferred from field-id if omitted)
23
+ -p, --placeholder string Placeholder text
24
+ --types string Output file for generated types (default: "prismicio-types.d.ts")
25
+ -h, --help Show help for command
26
+
27
+ EXAMPLES
28
+ prismic custom-type add-field image homepage hero
29
+ prismic custom-type add-field image article thumbnail --tab "Media"
30
+ prismic custom-type add-field image product photo --label "Product Photo"
31
+ `.trim();
32
+
33
+ export async function customTypeAddFieldImage(): Promise<void> {
34
+ const {
35
+ values: { help, tab, label, placeholder, types },
36
+ positionals: [typeId, fieldId],
37
+ } = parseArgs({
38
+ args: process.argv.slice(5), // skip: node, script, "custom-type", "add-field", "image"
39
+ options: {
40
+ tab: { type: "string", short: "t" },
41
+ label: { type: "string", short: "l" },
42
+ placeholder: { type: "string", short: "p" },
43
+ types: { type: "string" },
44
+ help: { type: "boolean", short: "h" },
45
+ },
46
+ allowPositionals: true,
47
+ });
48
+
49
+ if (help) {
50
+ console.info(HELP);
51
+ return;
52
+ }
53
+
54
+ if (!typeId) {
55
+ console.error("Missing required argument: type-id\n");
56
+ console.error("Usage: prismic custom-type add-field image <type-id> <field-id>");
57
+ process.exitCode = 1;
58
+ return;
59
+ }
60
+
61
+ if (!fieldId) {
62
+ console.error("Missing required argument: field-id\n");
63
+ console.error("Usage: prismic custom-type add-field image <type-id> <field-id>");
64
+ process.exitCode = 1;
65
+ return;
66
+ }
67
+
68
+ // Parse and validate field path
69
+ const fieldPath = parseFieldPath(fieldId);
70
+ const pathValidation = validateNestedFieldPath(fieldPath);
71
+ if (!pathValidation.ok) {
72
+ console.error(pathValidation.error);
73
+ process.exitCode = 1;
74
+ return;
75
+ }
76
+
77
+ const framework = await requireFramework();
78
+ if (!framework) return;
79
+
80
+ let model: CustomType;
81
+ try {
82
+ model = await framework.readCustomType(typeId);
83
+ } catch {
84
+ console.error(`Custom type not found: ${typeId}\n\nCreate it first with: prismic custom-type create ${typeId}`);
85
+ process.exitCode = 1;
86
+ return;
87
+ }
88
+
89
+ // Determine target tab
90
+ const existingTabs = Object.keys(model.json);
91
+ const targetTab = tab ?? existingTabs[0] ?? "Main";
92
+
93
+ // Initialize tab if it doesn't exist
94
+ if (!model.json[targetTab]) {
95
+ model.json[targetTab] = {};
96
+ }
97
+
98
+ // Build field definition
99
+ const fieldDefinition: Image = {
100
+ type: "Image",
101
+ config: {
102
+ label: label ?? humanReadable(fieldPath.type === "nested" ? fieldPath.nestedFieldId : fieldId),
103
+ ...(placeholder && { placeholder }),
104
+ },
105
+ };
106
+
107
+ // Add field to model
108
+ if (fieldPath.type === "nested") {
109
+ const groupResult = findGroupInTab(model.json[targetTab], fieldPath.groupId, targetTab);
110
+ if (!groupResult.ok) {
111
+ console.error(groupResult.error);
112
+ process.exitCode = 1;
113
+ return;
114
+ }
115
+ if (groupResult.group.config.fields[fieldPath.nestedFieldId]) {
116
+ console.error(`Field "${fieldPath.nestedFieldId}" already exists in group "${fieldPath.groupId}"`);
117
+ process.exitCode = 1;
118
+ return;
119
+ }
120
+ groupResult.group.config.fields[fieldPath.nestedFieldId] = fieldDefinition;
121
+ } else {
122
+ for (const [tabName, tabFields] of Object.entries(model.json)) {
123
+ if (tabFields[fieldId]) {
124
+ console.error(`Field "${fieldId}" already exists in tab "${tabName}"`);
125
+ process.exitCode = 1;
126
+ return;
127
+ }
128
+ for (const [groupFieldId, groupField] of Object.entries(tabFields)) {
129
+ if (isGroupField(groupField) && groupField.config.fields[fieldId]) {
130
+ console.error(`Field "${fieldId}" already exists in group "${groupFieldId}" in tab "${tabName}"`);
131
+ process.exitCode = 1;
132
+ return;
133
+ }
134
+ }
135
+ }
136
+ model.json[targetTab][fieldId] = fieldDefinition;
137
+ }
138
+
139
+ // Write updated model
140
+ try {
141
+ await framework.updateCustomType(model);
142
+ } catch (error) {
143
+ if (error instanceof Error) {
144
+ console.error(`Failed to update custom type: ${error.message}`);
145
+ } else {
146
+ console.error("Failed to update custom type");
147
+ }
148
+ process.exitCode = 1;
149
+ return;
150
+ }
151
+
152
+ if (fieldPath.type === "nested") {
153
+ console.info(`Added field "${fieldPath.nestedFieldId}" (Image) to group "${fieldPath.groupId}" in ${typeId}`);
154
+ } else {
155
+ console.info(`Added field "${fieldId}" (Image) to "${targetTab}" tab in ${typeId}`);
156
+ }
157
+
158
+ try {
159
+ await buildTypes({ output: types });
160
+ console.info(`Updated types in ${types ?? "prismicio-types.d.ts"}`);
161
+ } catch (error) {
162
+ console.warn(`Could not generate types: ${error instanceof Error ? error.message : error}`);
163
+ }
164
+
165
+ console.info();
166
+ console.info("Next: Add more fields with `prismic custom-type add-field`");
167
+ console.info(" Run `prismic status` when done to find next steps");
168
+ }