@sanity/cli 6.0.0-alpha.4 → 6.0.0-alpha.6

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 (608) hide show
  1. package/dist/actions/dataset/create.d.ts +49 -0
  2. package/dist/actions/dataset/create.js +48 -0
  3. package/dist/actions/dataset/create.js.map +1 -0
  4. package/dist/actions/dataset/determineDatasetAclMode.d.ts +37 -0
  5. package/dist/actions/dataset/determineDatasetAclMode.js +36 -0
  6. package/dist/actions/dataset/determineDatasetAclMode.js.map +1 -0
  7. package/dist/actions/debug/gatherDebugInfo.js +15 -21
  8. package/dist/actions/debug/gatherDebugInfo.js.map +1 -1
  9. package/dist/actions/debug/types.d.ts +0 -2
  10. package/dist/actions/debug/types.js.map +1 -1
  11. package/dist/actions/deploy/deployApp.js +13 -0
  12. package/dist/actions/deploy/deployApp.js.map +1 -1
  13. package/dist/actions/dev/startStudioDevServer.js +3 -8
  14. package/dist/actions/dev/startStudioDevServer.js.map +1 -1
  15. package/dist/actions/dev/types.d.ts +1 -3
  16. package/dist/actions/dev/types.js.map +1 -1
  17. package/dist/actions/documents/validate.d.ts +0 -2
  18. package/dist/actions/documents/validate.js +21 -1
  19. package/dist/actions/documents/validate.js.map +1 -1
  20. package/dist/actions/exec/execScript.js +1 -1
  21. package/dist/actions/exec/execScript.js.map +1 -1
  22. package/dist/actions/graphql/getGraphQLAPIs.js +1 -1
  23. package/dist/actions/graphql/getGraphQLAPIs.js.map +1 -1
  24. package/dist/actions/init/remoteTemplate.js +1 -1
  25. package/dist/actions/init/remoteTemplate.js.map +1 -1
  26. package/dist/actions/manifest/extractAppManifest.d.ts +20 -0
  27. package/dist/actions/manifest/extractAppManifest.js +51 -0
  28. package/dist/actions/manifest/extractAppManifest.js.map +1 -0
  29. package/dist/actions/manifest/extractManifest.js +2 -5
  30. package/dist/actions/manifest/extractManifest.js.map +1 -1
  31. package/dist/actions/manifest/types.d.ts +6 -1
  32. package/dist/actions/manifest/types.js.map +1 -1
  33. package/dist/actions/media/importAspects.js +2 -1
  34. package/dist/actions/media/importAspects.js.map +1 -1
  35. package/dist/actions/schema/deleteSchemaAction.d.ts +13 -5
  36. package/dist/actions/schema/deleteSchemaAction.js +12 -17
  37. package/dist/actions/schema/deleteSchemaAction.js.map +1 -1
  38. package/dist/actions/schema/deploySchemas.d.ts +15 -0
  39. package/dist/actions/schema/deploySchemas.js +98 -0
  40. package/dist/actions/schema/deploySchemas.js.map +1 -0
  41. package/dist/actions/schema/listSchemas.d.ts +12 -0
  42. package/dist/actions/schema/listSchemas.js +119 -0
  43. package/dist/actions/schema/listSchemas.js.map +1 -0
  44. package/dist/actions/schema/schemaStoreTypes.d.ts +0 -11
  45. package/dist/actions/schema/schemaStoreTypes.js.map +1 -1
  46. package/dist/actions/schema/utils/debug.d.ts +2 -0
  47. package/dist/actions/schema/utils/debug.js +5 -0
  48. package/dist/actions/schema/utils/debug.js.map +1 -0
  49. package/dist/actions/schema/utils/manifestExtractor.d.ts +3 -8
  50. package/dist/actions/schema/utils/manifestExtractor.js +12 -17
  51. package/dist/actions/schema/utils/manifestExtractor.js.map +1 -1
  52. package/dist/actions/schema/utils/manifestReader.d.ts +2 -9
  53. package/dist/actions/schema/utils/manifestReader.js +6 -12
  54. package/dist/actions/schema/utils/manifestReader.js.map +1 -1
  55. package/dist/actions/schema/utils/schemaStoreOutStrings.d.ts +0 -1
  56. package/dist/actions/schema/utils/schemaStoreOutStrings.js +1 -1
  57. package/dist/actions/schema/utils/schemaStoreOutStrings.js.map +1 -1
  58. package/dist/actions/schema/utils/schemaStoreValidation.d.ts +10 -62
  59. package/dist/actions/schema/utils/schemaStoreValidation.js +38 -125
  60. package/dist/actions/schema/utils/schemaStoreValidation.js.map +1 -1
  61. package/dist/actions/schema/utils/uniqByProjectIdDataset.d.ts +14 -0
  62. package/dist/actions/schema/utils/uniqByProjectIdDataset.js +9 -0
  63. package/dist/actions/schema/utils/uniqByProjectIdDataset.js.map +1 -0
  64. package/dist/actions/users/getMembersForProject.d.ts +1 -3
  65. package/dist/actions/users/getMembersForProject.js +6 -17
  66. package/dist/actions/users/getMembersForProject.js.map +1 -1
  67. package/dist/actions/users/types.d.ts +0 -11
  68. package/dist/actions/users/types.js.map +1 -1
  69. package/dist/commands/backup/disable.js +5 -11
  70. package/dist/commands/backup/disable.js.map +1 -1
  71. package/dist/commands/backup/enable.js +5 -11
  72. package/dist/commands/backup/enable.js.map +1 -1
  73. package/dist/commands/backup/list.js +7 -8
  74. package/dist/commands/backup/list.js.map +1 -1
  75. package/dist/commands/cors/add.js +5 -13
  76. package/dist/commands/cors/add.js.map +1 -1
  77. package/dist/commands/cors/delete.js +7 -15
  78. package/dist/commands/cors/delete.js.map +1 -1
  79. package/dist/commands/cors/list.js +2 -10
  80. package/dist/commands/cors/list.js.map +1 -1
  81. package/dist/commands/dataset/create.d.ts +0 -2
  82. package/dist/commands/dataset/create.js +8 -54
  83. package/dist/commands/dataset/create.js.map +1 -1
  84. package/dist/commands/dataset/export.js +4 -4
  85. package/dist/commands/dataset/export.js.map +1 -1
  86. package/dist/commands/debug.js +5 -9
  87. package/dist/commands/debug.js.map +1 -1
  88. package/dist/commands/dev.js +0 -1
  89. package/dist/commands/dev.js.map +1 -1
  90. package/dist/commands/documents/create.d.ts +1 -0
  91. package/dist/commands/documents/create.js +10 -9
  92. package/dist/commands/documents/create.js.map +1 -1
  93. package/dist/commands/documents/delete.js +2 -3
  94. package/dist/commands/documents/delete.js.map +1 -1
  95. package/dist/commands/documents/get.js +2 -3
  96. package/dist/commands/documents/get.js.map +1 -1
  97. package/dist/commands/documents/query.js +2 -3
  98. package/dist/commands/documents/query.js.map +1 -1
  99. package/dist/commands/documents/validate.js +0 -20
  100. package/dist/commands/documents/validate.js.map +1 -1
  101. package/dist/commands/graphql/list.js +2 -2
  102. package/dist/commands/graphql/list.js.map +1 -1
  103. package/dist/commands/graphql/undeploy.js +4 -9
  104. package/dist/commands/graphql/undeploy.js.map +1 -1
  105. package/dist/commands/hook/create.js +2 -6
  106. package/dist/commands/hook/create.js.map +1 -1
  107. package/dist/commands/hook/delete.js +5 -17
  108. package/dist/commands/hook/delete.js.map +1 -1
  109. package/dist/commands/hook/list.js +2 -8
  110. package/dist/commands/hook/list.js.map +1 -1
  111. package/dist/commands/init.d.ts +6 -1
  112. package/dist/commands/init.js +358 -20
  113. package/dist/commands/init.js.map +1 -1
  114. package/dist/commands/manifest/extract.js +7 -8
  115. package/dist/commands/manifest/extract.js.map +1 -1
  116. package/dist/commands/media/export.js +2 -2
  117. package/dist/commands/media/export.js.map +1 -1
  118. package/dist/commands/media/import.js +2 -2
  119. package/dist/commands/media/import.js.map +1 -1
  120. package/dist/commands/projects/list.js +2 -6
  121. package/dist/commands/projects/list.js.map +1 -1
  122. package/dist/commands/schema/delete.d.ts +1 -1
  123. package/dist/commands/schema/delete.js +20 -23
  124. package/dist/commands/schema/delete.js.map +1 -1
  125. package/dist/commands/schema/deploy.d.ts +16 -0
  126. package/dist/commands/schema/deploy.js +98 -0
  127. package/dist/commands/schema/deploy.js.map +1 -0
  128. package/dist/commands/schema/list.d.ts +15 -0
  129. package/dist/commands/schema/list.js +104 -0
  130. package/dist/commands/schema/list.js.map +1 -0
  131. package/dist/commands/tokens/add.js +3 -5
  132. package/dist/commands/tokens/add.js.map +1 -1
  133. package/dist/commands/users/invite.js +6 -17
  134. package/dist/commands/users/invite.js.map +1 -1
  135. package/dist/commands/users/list.js +4 -7
  136. package/dist/commands/users/list.js.map +1 -1
  137. package/dist/config/createCliConfig.d.ts +13 -4
  138. package/dist/prompts/init/promptForTypescript.d.ts +2 -0
  139. package/dist/prompts/init/promptForTypescript.js +15 -0
  140. package/dist/prompts/init/promptForTypescript.js.map +1 -0
  141. package/dist/prompts/promptForDatasetAclMode.d.ts +9 -0
  142. package/dist/prompts/promptForDatasetAclMode.js +27 -0
  143. package/dist/prompts/promptForDatasetAclMode.js.map +1 -0
  144. package/dist/prompts/promptForDatasetName.d.ts +1 -1
  145. package/dist/prompts/promptForDatasetName.js +4 -1
  146. package/dist/prompts/promptForDatasetName.js.map +1 -1
  147. package/dist/services/backup.d.ts +8 -0
  148. package/dist/services/backup.js +19 -0
  149. package/dist/services/backup.js.map +1 -1
  150. package/dist/services/cors.d.ts +23 -0
  151. package/dist/services/cors.js +38 -0
  152. package/dist/services/cors.js.map +1 -0
  153. package/dist/services/graphql.d.ts +7 -0
  154. package/dist/services/graphql.js +11 -0
  155. package/dist/services/graphql.js.map +1 -1
  156. package/dist/services/hooks.d.ts +2 -0
  157. package/dist/services/hooks.js +19 -0
  158. package/dist/services/hooks.js.map +1 -1
  159. package/dist/services/organizations.d.ts +4 -2
  160. package/dist/services/organizations.js +3 -2
  161. package/dist/services/organizations.js.map +1 -1
  162. package/dist/services/projects.d.ts +11 -0
  163. package/dist/services/projects.js +41 -0
  164. package/dist/services/projects.js.map +1 -1
  165. package/dist/services/schemas.d.ts +4 -0
  166. package/dist/services/schemas.js +40 -0
  167. package/dist/services/schemas.js.map +1 -0
  168. package/dist/services/user.d.ts +13 -0
  169. package/dist/services/user.js +27 -3
  170. package/dist/services/user.js.map +1 -1
  171. package/dist/services/userApplications.d.ts +3 -1
  172. package/dist/services/userApplications.js +5 -1
  173. package/dist/services/userApplications.js.map +1 -1
  174. package/dist/util/errorMessages.d.ts +1 -0
  175. package/dist/util/errorMessages.js +1 -0
  176. package/dist/util/errorMessages.js.map +1 -1
  177. package/dist/util/getCliVersion.js +1 -1
  178. package/dist/util/getCliVersion.js.map +1 -1
  179. package/dist/util/readPackageJson.d.ts +1 -15
  180. package/dist/util/readPackageJson.js +1 -1
  181. package/dist/util/readPackageJson.js.map +1 -1
  182. package/dist/util/uniqBy.d.ts +1 -0
  183. package/dist/util/uniqBy.js +14 -0
  184. package/dist/util/uniqBy.js.map +1 -0
  185. package/oclif.manifest.json +284 -139
  186. package/package.json +36 -33
  187. package/templates/app-quickstart/src/App.css +20 -0
  188. package/templates/app-quickstart/src/App.tsx +25 -0
  189. package/templates/app-quickstart/src/ExampleComponent.css +90 -0
  190. package/templates/app-quickstart/src/ExampleComponent.tsx +37 -0
  191. package/templates/app-sanity-ui/src/App.tsx +34 -0
  192. package/templates/app-sanity-ui/src/ExampleComponent.tsx +34 -0
  193. package/templates/app-sanity-ui/src/SanityUI.tsx +23 -0
  194. package/templates/blog/README.md +11 -0
  195. package/templates/blog/schemaTypes/author.js +50 -0
  196. package/templates/blog/schemaTypes/blockContent.js +67 -0
  197. package/templates/blog/schemaTypes/category.js +19 -0
  198. package/templates/blog/schemaTypes/index.js +6 -0
  199. package/templates/blog/schemaTypes/post.js +65 -0
  200. package/templates/blog/static/.gitkeep +1 -0
  201. package/templates/clean/README.md +9 -0
  202. package/templates/clean/schemaTypes/index.js +1 -0
  203. package/templates/clean/static/.gitkeep +1 -0
  204. package/templates/ecommerce/README.md +11 -0
  205. package/templates/ecommerce/plugins/.gitkeep +1 -0
  206. package/templates/ecommerce/plugins/barcode-input/BarcodeInput.js +62 -0
  207. package/templates/ecommerce/plugins/barcode-input/index.js +9 -0
  208. package/templates/ecommerce/plugins/barcode-input/schemaType.js +60 -0
  209. package/templates/ecommerce/schemaTypes/blockContent.js +67 -0
  210. package/templates/ecommerce/schemaTypes/category.js +39 -0
  211. package/templates/ecommerce/schemaTypes/index.js +23 -0
  212. package/templates/ecommerce/schemaTypes/locale/localeBlockContent.js +19 -0
  213. package/templates/ecommerce/schemaTypes/locale/localeString.js +19 -0
  214. package/templates/ecommerce/schemaTypes/locale/localeText.js +19 -0
  215. package/templates/ecommerce/schemaTypes/locale/supportedLanguages.js +5 -0
  216. package/templates/ecommerce/schemaTypes/product.js +83 -0
  217. package/templates/ecommerce/schemaTypes/productVariant.js +52 -0
  218. package/templates/ecommerce/schemaTypes/vendor.js +39 -0
  219. package/templates/ecommerce/static/.gitkeep +1 -0
  220. package/templates/get-started/README.md +9 -0
  221. package/templates/get-started/plugins/.gitkeep +1 -0
  222. package/templates/get-started/plugins/sanity-plugin-tutorial/CustomDefaultLayout.tsx +16 -0
  223. package/templates/get-started/plugins/sanity-plugin-tutorial/GetStartedTutorial.tsx +104 -0
  224. package/templates/get-started/plugins/sanity-plugin-tutorial/index.ts +11 -0
  225. package/templates/get-started/schemaTypes/index.ts +1 -0
  226. package/templates/get-started/static/.gitkeep +1 -0
  227. package/templates/moviedb/README.md +10 -0
  228. package/templates/moviedb/schemaTypes/blockContent.js +67 -0
  229. package/templates/moviedb/schemaTypes/castMember.js +37 -0
  230. package/templates/moviedb/schemaTypes/crewMember.js +52 -0
  231. package/templates/moviedb/schemaTypes/index.js +22 -0
  232. package/templates/moviedb/schemaTypes/movie.js +85 -0
  233. package/templates/moviedb/schemaTypes/person.js +37 -0
  234. package/templates/moviedb/schemaTypes/plotSummaries.js +20 -0
  235. package/templates/moviedb/schemaTypes/plotSummary.js +24 -0
  236. package/templates/moviedb/schemaTypes/screening.js +81 -0
  237. package/templates/moviedb/static/.gitkeep +1 -0
  238. package/templates/quickstart/README.md +9 -0
  239. package/templates/quickstart/schemaTypes/index.js +1 -0
  240. package/templates/quickstart/static/.gitkeep +1 -0
  241. package/templates/shared/gitignore.txt +29 -0
  242. package/templates/shared/tsconfig.json +17 -0
  243. package/templates/shopify/README.md +85 -0
  244. package/templates/shopify/components/hotspots/ProductTooltip.tsx +38 -0
  245. package/templates/shopify/components/icons/Shopify.tsx +20 -0
  246. package/templates/shopify/components/inputs/CollectionHidden.tsx +23 -0
  247. package/templates/shopify/components/inputs/PlaceholderString.tsx +20 -0
  248. package/templates/shopify/components/inputs/ProductHidden.tsx +64 -0
  249. package/templates/shopify/components/inputs/ProductVariantHidden.tsx +24 -0
  250. package/templates/shopify/components/inputs/ProxyString.tsx +32 -0
  251. package/templates/shopify/components/media/ColorTheme.tsx +38 -0
  252. package/templates/shopify/components/media/ShopifyDocumentStatus.tsx +82 -0
  253. package/templates/shopify/components/studio/Navbar.tsx +29 -0
  254. package/templates/shopify/constants.ts +61 -0
  255. package/templates/shopify/docs/features.md +158 -0
  256. package/templates/shopify/plugins/customDocumentActions/index.ts +55 -0
  257. package/templates/shopify/plugins/customDocumentActions/shopifyDelete.tsx +144 -0
  258. package/templates/shopify/plugins/customDocumentActions/shopifyLink.ts +39 -0
  259. package/templates/shopify/plugins/customDocumentActions/types.ts +14 -0
  260. package/templates/shopify/schemaTypes/documents/collection.tsx +142 -0
  261. package/templates/shopify/schemaTypes/documents/colorTheme.tsx +44 -0
  262. package/templates/shopify/schemaTypes/documents/page.ts +70 -0
  263. package/templates/shopify/schemaTypes/documents/product.tsx +132 -0
  264. package/templates/shopify/schemaTypes/documents/productVariant.tsx +67 -0
  265. package/templates/shopify/schemaTypes/index.ts +108 -0
  266. package/templates/shopify/schemaTypes/objects/collection/collectionGroupType.ts +27 -0
  267. package/templates/shopify/schemaTypes/objects/collection/collectionLinksType.ts +16 -0
  268. package/templates/shopify/schemaTypes/objects/customProductOption/customProductOptionColorObjectType.tsx +48 -0
  269. package/templates/shopify/schemaTypes/objects/customProductOption/customProductOptionColorType.tsx +50 -0
  270. package/templates/shopify/schemaTypes/objects/customProductOption/customProductOptionSizeObjectType.ts +40 -0
  271. package/templates/shopify/schemaTypes/objects/customProductOption/customProductOptionSizeType.ts +49 -0
  272. package/templates/shopify/schemaTypes/objects/global/footerType.ts +22 -0
  273. package/templates/shopify/schemaTypes/objects/global/menuLinksType.ts +21 -0
  274. package/templates/shopify/schemaTypes/objects/global/menuType.ts +17 -0
  275. package/templates/shopify/schemaTypes/objects/global/notFoundPageType.ts +37 -0
  276. package/templates/shopify/schemaTypes/objects/hotspot/imageWithProductHotspotsType.ts +48 -0
  277. package/templates/shopify/schemaTypes/objects/hotspot/productHotspotsType.tsx +17 -0
  278. package/templates/shopify/schemaTypes/objects/hotspot/spotType.tsx +60 -0
  279. package/templates/shopify/schemaTypes/objects/link/linkEmailType.tsx +34 -0
  280. package/templates/shopify/schemaTypes/objects/link/linkExternalType.tsx +37 -0
  281. package/templates/shopify/schemaTypes/objects/link/linkInternalType.tsx +33 -0
  282. package/templates/shopify/schemaTypes/objects/link/linkProductType.tsx +60 -0
  283. package/templates/shopify/schemaTypes/objects/module/accordionGroupType.ts +33 -0
  284. package/templates/shopify/schemaTypes/objects/module/accordionType.ts +28 -0
  285. package/templates/shopify/schemaTypes/objects/module/callToActionType.tsx +85 -0
  286. package/templates/shopify/schemaTypes/objects/module/calloutType.ts +38 -0
  287. package/templates/shopify/schemaTypes/objects/module/collectionReferenceType.tsx +47 -0
  288. package/templates/shopify/schemaTypes/objects/module/gridItemType.ts +41 -0
  289. package/templates/shopify/schemaTypes/objects/module/gridType.ts +28 -0
  290. package/templates/shopify/schemaTypes/objects/module/heroType.tsx +40 -0
  291. package/templates/shopify/schemaTypes/objects/module/imageCallToActionType.tsx +19 -0
  292. package/templates/shopify/schemaTypes/objects/module/imageFeatureType.ts +80 -0
  293. package/templates/shopify/schemaTypes/objects/module/imageFeaturesType.tsx +51 -0
  294. package/templates/shopify/schemaTypes/objects/module/instagramType.ts +35 -0
  295. package/templates/shopify/schemaTypes/objects/module/productFeaturesType.tsx +50 -0
  296. package/templates/shopify/schemaTypes/objects/module/productReferenceType.tsx +42 -0
  297. package/templates/shopify/schemaTypes/objects/seoType.ts +31 -0
  298. package/templates/shopify/schemaTypes/objects/shopify/collectionRuleType.tsx +37 -0
  299. package/templates/shopify/schemaTypes/objects/shopify/inventoryType.ts +25 -0
  300. package/templates/shopify/schemaTypes/objects/shopify/optionType.tsx +31 -0
  301. package/templates/shopify/schemaTypes/objects/shopify/placeholderStringType.ts +11 -0
  302. package/templates/shopify/schemaTypes/objects/shopify/priceRangeType.ts +20 -0
  303. package/templates/shopify/schemaTypes/objects/shopify/productWithVariantType.tsx +142 -0
  304. package/templates/shopify/schemaTypes/objects/shopify/proxyStringType.ts +12 -0
  305. package/templates/shopify/schemaTypes/objects/shopify/shopType.ts +15 -0
  306. package/templates/shopify/schemaTypes/objects/shopify/shopifyCollectionType.ts +84 -0
  307. package/templates/shopify/schemaTypes/objects/shopify/shopifyProductType.ts +131 -0
  308. package/templates/shopify/schemaTypes/objects/shopify/shopifyProductVariantType.ts +121 -0
  309. package/templates/shopify/schemaTypes/portableText/portableTextSimpleType.tsx +45 -0
  310. package/templates/shopify/schemaTypes/portableText/portableTextType.tsx +52 -0
  311. package/templates/shopify/schemaTypes/singletons/homeType.ts +49 -0
  312. package/templates/shopify/schemaTypes/singletons/settingsType.ts +96 -0
  313. package/templates/shopify/static/.gitkeep +1 -0
  314. package/templates/shopify/structure/collectionStructure.ts +9 -0
  315. package/templates/shopify/structure/colorThemeStructure.ts +9 -0
  316. package/templates/shopify/structure/homeStructure.ts +9 -0
  317. package/templates/shopify/structure/index.ts +57 -0
  318. package/templates/shopify/structure/pageStructure.ts +11 -0
  319. package/templates/shopify/structure/productStructure.ts +51 -0
  320. package/templates/shopify/structure/settingStructure.ts +9 -0
  321. package/templates/shopify/utils/blocksToText.ts +20 -0
  322. package/templates/shopify/utils/defineStructure.ts +11 -0
  323. package/templates/shopify/utils/getPriceRange.ts +24 -0
  324. package/templates/shopify/utils/shopifyUrls.ts +22 -0
  325. package/templates/shopify/utils/validateSlug.ts +18 -0
  326. package/templates/shopify-online-storefront/README.md +54 -0
  327. package/templates/shopify-online-storefront/components/icons/Shopify.tsx +22 -0
  328. package/templates/shopify-online-storefront/components/inputs/CollectionHidden.tsx +23 -0
  329. package/templates/shopify-online-storefront/components/inputs/PlaceholderString.tsx +25 -0
  330. package/templates/shopify-online-storefront/components/inputs/ProductHidden.tsx +66 -0
  331. package/templates/shopify-online-storefront/components/inputs/ProductVariantHidden.tsx +25 -0
  332. package/templates/shopify-online-storefront/components/inputs/ProxyString.tsx +38 -0
  333. package/templates/shopify-online-storefront/components/media/ShopifyDocumentStatus.tsx +83 -0
  334. package/templates/shopify-online-storefront/constants.ts +18 -0
  335. package/templates/shopify-online-storefront/plugins/shopifyDocumentActions/index.ts +45 -0
  336. package/templates/shopify-online-storefront/plugins/shopifyDocumentActions/shopifyDelete.tsx +144 -0
  337. package/templates/shopify-online-storefront/plugins/shopifyDocumentActions/shopifyLink.ts +39 -0
  338. package/templates/shopify-online-storefront/plugins/shopifyDocumentActions/types.ts +14 -0
  339. package/templates/shopify-online-storefront/schemaTypes/blocks/blockContent.ts +32 -0
  340. package/templates/shopify-online-storefront/schemaTypes/documents/collection.tsx +83 -0
  341. package/templates/shopify-online-storefront/schemaTypes/documents/product.tsx +102 -0
  342. package/templates/shopify-online-storefront/schemaTypes/documents/productVariant.tsx +82 -0
  343. package/templates/shopify-online-storefront/schemaTypes/index.ts +43 -0
  344. package/templates/shopify-online-storefront/schemaTypes/objects/accordion.ts +31 -0
  345. package/templates/shopify-online-storefront/schemaTypes/objects/accordionGroup.ts +35 -0
  346. package/templates/shopify-online-storefront/schemaTypes/objects/callout.ts +40 -0
  347. package/templates/shopify-online-storefront/schemaTypes/objects/inventory.ts +30 -0
  348. package/templates/shopify-online-storefront/schemaTypes/objects/option.ts +30 -0
  349. package/templates/shopify-online-storefront/schemaTypes/objects/priceRange.ts +22 -0
  350. package/templates/shopify-online-storefront/schemaTypes/objects/proxyString.ts +11 -0
  351. package/templates/shopify-online-storefront/schemaTypes/objects/shopifyCollection.ts +109 -0
  352. package/templates/shopify-online-storefront/schemaTypes/objects/shopifyCollectionRule.tsx +45 -0
  353. package/templates/shopify-online-storefront/schemaTypes/objects/shopifyProduct.ts +165 -0
  354. package/templates/shopify-online-storefront/schemaTypes/objects/shopifyProductVariant.ts +151 -0
  355. package/templates/shopify-online-storefront/structure/collectionStructure.ts +9 -0
  356. package/templates/shopify-online-storefront/structure/index.ts +37 -0
  357. package/templates/shopify-online-storefront/structure/productStructure.ts +35 -0
  358. package/templates/shopify-online-storefront/utils/defineStructure.ts +11 -0
  359. package/templates/shopify-online-storefront/utils/getPriceRange.ts +24 -0
  360. package/templates/shopify-online-storefront/utils/shopifyUrls.ts +22 -0
  361. package/dist/actions/build/__tests__/buildApp.test.js +0 -367
  362. package/dist/actions/build/__tests__/buildApp.test.js.map +0 -1
  363. package/dist/actions/build/__tests__/buildStudio.test.js +0 -561
  364. package/dist/actions/build/__tests__/buildStudio.test.js.map +0 -1
  365. package/dist/actions/build/__tests__/checkRequiredDependencies.test.js +0 -233
  366. package/dist/actions/build/__tests__/checkRequiredDependencies.test.js.map +0 -1
  367. package/dist/actions/build/__tests__/checkStudioDependencyVersions.test.js +0 -414
  368. package/dist/actions/build/__tests__/checkStudioDependencyVersions.test.js.map +0 -1
  369. package/dist/actions/build/__tests__/determineBasePath.test.js +0 -24
  370. package/dist/actions/build/__tests__/determineBasePath.test.js.map +0 -1
  371. package/dist/actions/build/__tests__/getAutoUpdatesImportMap.test.js +0 -109
  372. package/dist/actions/build/__tests__/getAutoUpdatesImportMap.test.js.map +0 -1
  373. package/dist/actions/build/__tests__/getViteConfig.test.js +0 -493
  374. package/dist/actions/build/__tests__/getViteConfig.test.js.map +0 -1
  375. package/dist/actions/build/__tests__/renderDocument.test.js +0 -278
  376. package/dist/actions/build/__tests__/renderDocument.test.js.map +0 -1
  377. package/dist/actions/build/__tests__/shouldAutoUpdate.test.js +0 -153
  378. package/dist/actions/build/__tests__/shouldAutoUpdate.test.js.map +0 -1
  379. package/dist/actions/build/renderDocumentWorker/__tests__/renderDocumentWorker.test.js +0 -657
  380. package/dist/actions/build/renderDocumentWorker/__tests__/renderDocumentWorker.test.js.map +0 -1
  381. package/dist/actions/cors/constants.d.ts +0 -1
  382. package/dist/actions/cors/constants.js +0 -3
  383. package/dist/actions/cors/constants.js.map +0 -1
  384. package/dist/actions/cors/types.d.ts +0 -9
  385. package/dist/actions/cors/types.js +0 -3
  386. package/dist/actions/cors/types.js.map +0 -1
  387. package/dist/actions/dataset/__tests__/validateDatasetName.test.js +0 -182
  388. package/dist/actions/dataset/__tests__/validateDatasetName.test.js.map +0 -1
  389. package/dist/actions/deploy/__tests__/checkDir.test.js +0 -120
  390. package/dist/actions/deploy/__tests__/checkDir.test.js.map +0 -1
  391. package/dist/actions/docs/__tests__/normalizeDocsPath.test.js +0 -16
  392. package/dist/actions/docs/__tests__/normalizeDocsPath.test.js.map +0 -1
  393. package/dist/actions/documents/validation/reporters/prettyReporter/__tests__/formatDocumentValidation.test.js +0 -124
  394. package/dist/actions/documents/validation/reporters/prettyReporter/__tests__/formatDocumentValidation.test.js.map +0 -1
  395. package/dist/actions/graphql/__tests__/getGraphQLAPIs.test.js +0 -274
  396. package/dist/actions/graphql/__tests__/getGraphQLAPIs.test.js.map +0 -1
  397. package/dist/actions/media/__tests__/importMedia.test.js +0 -182
  398. package/dist/actions/media/__tests__/importMedia.test.js.map +0 -1
  399. package/dist/actions/schema/__tests__/deleteSchemaAction.test.js +0 -294
  400. package/dist/actions/schema/__tests__/deleteSchemaAction.test.js.map +0 -1
  401. package/dist/actions/schema/__tests__/formatSchemaValidation.test.js +0 -174
  402. package/dist/actions/schema/__tests__/formatSchemaValidation.test.js.map +0 -1
  403. package/dist/actions/schema/__tests__/validateAction.test.js +0 -281
  404. package/dist/actions/schema/__tests__/validateAction.test.js.map +0 -1
  405. package/dist/actions/schema/schemaStoreConstants.d.ts +0 -1
  406. package/dist/actions/schema/schemaStoreConstants.js +0 -4
  407. package/dist/actions/schema/schemaStoreConstants.js.map +0 -1
  408. package/dist/actions/schema/utils/schemaActionHelpers.d.ts +0 -1
  409. package/dist/actions/schema/utils/schemaActionHelpers.js +0 -5
  410. package/dist/actions/schema/utils/schemaActionHelpers.js.map +0 -1
  411. package/dist/actions/schema/utils/schemaApiClient.d.ts +0 -6
  412. package/dist/actions/schema/utils/schemaApiClient.js +0 -17
  413. package/dist/actions/schema/utils/schemaApiClient.js.map +0 -1
  414. package/dist/actions/telemetry/__tests__/fetchTelemetryConsent.test.js +0 -27
  415. package/dist/actions/telemetry/__tests__/fetchTelemetryConsent.test.js.map +0 -1
  416. package/dist/actions/users/__tests__/validateEmail.test.js +0 -16
  417. package/dist/actions/users/__tests__/validateEmail.test.js.map +0 -1
  418. package/dist/actions/users/apiVersion.d.ts +0 -6
  419. package/dist/actions/users/apiVersion.js +0 -7
  420. package/dist/actions/users/apiVersion.js.map +0 -1
  421. package/dist/commands/__tests__/blueprints.test.js +0 -54
  422. package/dist/commands/__tests__/blueprints.test.js.map +0 -1
  423. package/dist/commands/__tests__/build.test.js +0 -132
  424. package/dist/commands/__tests__/build.test.js.map +0 -1
  425. package/dist/commands/__tests__/codemod.test.js +0 -271
  426. package/dist/commands/__tests__/codemod.test.js.map +0 -1
  427. package/dist/commands/__tests__/debug.test.js +0 -697
  428. package/dist/commands/__tests__/debug.test.js.map +0 -1
  429. package/dist/commands/__tests__/deploy.test.js +0 -1913
  430. package/dist/commands/__tests__/deploy.test.js.map +0 -1
  431. package/dist/commands/__tests__/dev.test.js +0 -410
  432. package/dist/commands/__tests__/dev.test.js.map +0 -1
  433. package/dist/commands/__tests__/exec.test.js +0 -207
  434. package/dist/commands/__tests__/exec.test.js.map +0 -1
  435. package/dist/commands/__tests__/init/init.authentication.test.js +0 -60
  436. package/dist/commands/__tests__/init/init.authentication.test.js.map +0 -1
  437. package/dist/commands/__tests__/init/init.create-new-project.test.js +0 -196
  438. package/dist/commands/__tests__/init/init.create-new-project.test.js.map +0 -1
  439. package/dist/commands/__tests__/init/init.plan.test.js +0 -220
  440. package/dist/commands/__tests__/init/init.plan.test.js.map +0 -1
  441. package/dist/commands/__tests__/init/init.setup.test.js +0 -279
  442. package/dist/commands/__tests__/init/init.setup.test.js.map +0 -1
  443. package/dist/commands/__tests__/install.test.js +0 -258
  444. package/dist/commands/__tests__/install.test.js.map +0 -1
  445. package/dist/commands/__tests__/learn.test.js +0 -29
  446. package/dist/commands/__tests__/learn.test.js.map +0 -1
  447. package/dist/commands/__tests__/logout.test.js +0 -88
  448. package/dist/commands/__tests__/logout.test.js.map +0 -1
  449. package/dist/commands/__tests__/manage.test.js +0 -105
  450. package/dist/commands/__tests__/manage.test.js.map +0 -1
  451. package/dist/commands/__tests__/migration.test.js +0 -119
  452. package/dist/commands/__tests__/migration.test.js.map +0 -1
  453. package/dist/commands/__tests__/preview.test.js +0 -261
  454. package/dist/commands/__tests__/preview.test.js.map +0 -1
  455. package/dist/commands/__tests__/start.test.js +0 -253
  456. package/dist/commands/__tests__/start.test.js.map +0 -1
  457. package/dist/commands/__tests__/undeploy.test.js +0 -382
  458. package/dist/commands/__tests__/undeploy.test.js.map +0 -1
  459. package/dist/commands/__tests__/versions.test.js +0 -134
  460. package/dist/commands/__tests__/versions.test.js.map +0 -1
  461. package/dist/commands/backup/__tests__/disable.test.js +0 -207
  462. package/dist/commands/backup/__tests__/disable.test.js.map +0 -1
  463. package/dist/commands/backup/__tests__/download.test.js +0 -679
  464. package/dist/commands/backup/__tests__/download.test.js.map +0 -1
  465. package/dist/commands/backup/__tests__/enable.test.js +0 -317
  466. package/dist/commands/backup/__tests__/enable.test.js.map +0 -1
  467. package/dist/commands/backup/__tests__/list.test.js +0 -321
  468. package/dist/commands/backup/__tests__/list.test.js.map +0 -1
  469. package/dist/commands/cors/__tests__/add.test.js +0 -346
  470. package/dist/commands/cors/__tests__/add.test.js.map +0 -1
  471. package/dist/commands/cors/__tests__/delete.test.js +0 -293
  472. package/dist/commands/cors/__tests__/delete.test.js.map +0 -1
  473. package/dist/commands/cors/__tests__/list.test.js +0 -218
  474. package/dist/commands/cors/__tests__/list.test.js.map +0 -1
  475. package/dist/commands/dataset/__tests__/copy.test.js +0 -520
  476. package/dist/commands/dataset/__tests__/copy.test.js.map +0 -1
  477. package/dist/commands/dataset/__tests__/create.test.js +0 -312
  478. package/dist/commands/dataset/__tests__/create.test.js.map +0 -1
  479. package/dist/commands/dataset/__tests__/delete.test.js +0 -224
  480. package/dist/commands/dataset/__tests__/delete.test.js.map +0 -1
  481. package/dist/commands/dataset/__tests__/export.test.js +0 -561
  482. package/dist/commands/dataset/__tests__/export.test.js.map +0 -1
  483. package/dist/commands/dataset/__tests__/import.test.js +0 -53
  484. package/dist/commands/dataset/__tests__/import.test.js.map +0 -1
  485. package/dist/commands/dataset/__tests__/list.test.js +0 -174
  486. package/dist/commands/dataset/__tests__/list.test.js.map +0 -1
  487. package/dist/commands/dataset/alias/__tests__/create.test.js +0 -299
  488. package/dist/commands/dataset/alias/__tests__/create.test.js.map +0 -1
  489. package/dist/commands/dataset/alias/__tests__/delete.test.js +0 -236
  490. package/dist/commands/dataset/alias/__tests__/delete.test.js.map +0 -1
  491. package/dist/commands/dataset/alias/__tests__/link.test.js +0 -336
  492. package/dist/commands/dataset/alias/__tests__/link.test.js.map +0 -1
  493. package/dist/commands/dataset/alias/__tests__/unlink.test.js +0 -298
  494. package/dist/commands/dataset/alias/__tests__/unlink.test.js.map +0 -1
  495. package/dist/commands/dataset/visibility/__tests__/get.test.js +0 -147
  496. package/dist/commands/dataset/visibility/__tests__/get.test.js.map +0 -1
  497. package/dist/commands/dataset/visibility/__tests__/set.test.js +0 -245
  498. package/dist/commands/dataset/visibility/__tests__/set.test.js.map +0 -1
  499. package/dist/commands/docs/__tests__/browse.test.js +0 -29
  500. package/dist/commands/docs/__tests__/browse.test.js.map +0 -1
  501. package/dist/commands/docs/__tests__/read.test.js +0 -78
  502. package/dist/commands/docs/__tests__/read.test.js.map +0 -1
  503. package/dist/commands/docs/__tests__/search.test.js +0 -254
  504. package/dist/commands/docs/__tests__/search.test.js.map +0 -1
  505. package/dist/commands/documents/__tests__/create.test.js +0 -967
  506. package/dist/commands/documents/__tests__/create.test.js.map +0 -1
  507. package/dist/commands/documents/__tests__/delete.test.js +0 -268
  508. package/dist/commands/documents/__tests__/delete.test.js.map +0 -1
  509. package/dist/commands/documents/__tests__/get.test.js +0 -209
  510. package/dist/commands/documents/__tests__/get.test.js.map +0 -1
  511. package/dist/commands/documents/__tests__/query.test.js +0 -405
  512. package/dist/commands/documents/__tests__/query.test.js.map +0 -1
  513. package/dist/commands/documents/__tests__/validate.test.js +0 -226
  514. package/dist/commands/documents/__tests__/validate.test.js.map +0 -1
  515. package/dist/commands/graphql/__tests__/list.test.js +0 -228
  516. package/dist/commands/graphql/__tests__/list.test.js.map +0 -1
  517. package/dist/commands/graphql/__tests__/undeploy.test.js +0 -384
  518. package/dist/commands/graphql/__tests__/undeploy.test.js.map +0 -1
  519. package/dist/commands/hook/__tests__/attempt.test.js +0 -260
  520. package/dist/commands/hook/__tests__/attempt.test.js.map +0 -1
  521. package/dist/commands/hook/__tests__/create.test.js +0 -121
  522. package/dist/commands/hook/__tests__/create.test.js.map +0 -1
  523. package/dist/commands/hook/__tests__/delete.test.js +0 -220
  524. package/dist/commands/hook/__tests__/delete.test.js.map +0 -1
  525. package/dist/commands/hook/__tests__/list.test.js +0 -138
  526. package/dist/commands/hook/__tests__/list.test.js.map +0 -1
  527. package/dist/commands/hook/__tests__/logs.test.js +0 -770
  528. package/dist/commands/hook/__tests__/logs.test.js.map +0 -1
  529. package/dist/commands/manifest/__tests__/extract.test.js +0 -123
  530. package/dist/commands/manifest/__tests__/extract.test.js.map +0 -1
  531. package/dist/commands/mcp/__tests__/configure.test.js +0 -397
  532. package/dist/commands/mcp/__tests__/configure.test.js.map +0 -1
  533. package/dist/commands/media/__tests__/create-aspect.test.js +0 -160
  534. package/dist/commands/media/__tests__/create-aspect.test.js.map +0 -1
  535. package/dist/commands/media/__tests__/delete-aspect.test.js +0 -333
  536. package/dist/commands/media/__tests__/delete-aspect.test.js.map +0 -1
  537. package/dist/commands/media/__tests__/deploy-aspect.test.js +0 -632
  538. package/dist/commands/media/__tests__/deploy-aspect.test.js.map +0 -1
  539. package/dist/commands/media/__tests__/export.test.js +0 -398
  540. package/dist/commands/media/__tests__/export.test.js.map +0 -1
  541. package/dist/commands/media/__tests__/import.test.js +0 -281
  542. package/dist/commands/media/__tests__/import.test.js.map +0 -1
  543. package/dist/commands/openapi/__tests__/get.test.js +0 -149
  544. package/dist/commands/openapi/__tests__/get.test.js.map +0 -1
  545. package/dist/commands/openapi/__tests__/list.test.js +0 -113
  546. package/dist/commands/openapi/__tests__/list.test.js.map +0 -1
  547. package/dist/commands/projects/__tests__/list.test.js +0 -153
  548. package/dist/commands/projects/__tests__/list.test.js.map +0 -1
  549. package/dist/commands/schema/__tests__/delete.test.js +0 -209
  550. package/dist/commands/schema/__tests__/delete.test.js.map +0 -1
  551. package/dist/commands/schema/__tests__/extract.test.js +0 -113
  552. package/dist/commands/schema/__tests__/extract.test.js.map +0 -1
  553. package/dist/commands/schema/__tests__/validate.test.js +0 -104
  554. package/dist/commands/schema/__tests__/validate.test.js.map +0 -1
  555. package/dist/commands/telemetry/__tests__/disable.test.js +0 -145
  556. package/dist/commands/telemetry/__tests__/disable.test.js.map +0 -1
  557. package/dist/commands/telemetry/__tests__/enable.test.js +0 -131
  558. package/dist/commands/telemetry/__tests__/enable.test.js.map +0 -1
  559. package/dist/commands/telemetry/__tests__/status.test.js +0 -153
  560. package/dist/commands/telemetry/__tests__/status.test.js.map +0 -1
  561. package/dist/commands/tokens/__tests__/add.test.js +0 -420
  562. package/dist/commands/tokens/__tests__/add.test.js.map +0 -1
  563. package/dist/commands/tokens/__tests__/delete.test.js +0 -375
  564. package/dist/commands/tokens/__tests__/delete.test.js.map +0 -1
  565. package/dist/commands/tokens/__tests__/list.test.js +0 -368
  566. package/dist/commands/tokens/__tests__/list.test.js.map +0 -1
  567. package/dist/commands/users/__tests__/invite.test.js +0 -341
  568. package/dist/commands/users/__tests__/invite.test.js.map +0 -1
  569. package/dist/commands/users/__tests__/list.test.js +0 -401
  570. package/dist/commands/users/__tests__/list.test.js.map +0 -1
  571. package/dist/hooks/prerun/__tests__/setupTelemetry.test.js +0 -77
  572. package/dist/hooks/prerun/__tests__/setupTelemetry.test.js.map +0 -1
  573. package/dist/services/__tests__/datasetAliases.test.js +0 -131
  574. package/dist/services/__tests__/datasetAliases.test.js.map +0 -1
  575. package/dist/services/__tests__/datasets.test.js +0 -436
  576. package/dist/services/__tests__/datasets.test.js.map +0 -1
  577. package/dist/services/__tests__/graphql.test.js +0 -43
  578. package/dist/services/__tests__/graphql.test.js.map +0 -1
  579. package/dist/services/__tests__/mediaLibraries.test.js +0 -88
  580. package/dist/services/__tests__/mediaLibraries.test.js.map +0 -1
  581. package/dist/services/__tests__/projects.test.js +0 -41
  582. package/dist/services/__tests__/projects.test.js.map +0 -1
  583. package/dist/services/__tests__/userApplications.test.js +0 -113
  584. package/dist/services/__tests__/userApplications.test.js.map +0 -1
  585. package/dist/util/__tests__/appId.test.js +0 -31
  586. package/dist/util/__tests__/appId.test.js.map +0 -1
  587. package/dist/util/__tests__/cliClient.test.js +0 -184
  588. package/dist/util/__tests__/cliClient.test.js.map +0 -1
  589. package/dist/util/__tests__/compareDependencyVersions.test.js +0 -426
  590. package/dist/util/__tests__/compareDependencyVersions.test.js.map +0 -1
  591. package/dist/util/__tests__/extractDocumentsFromNdjsonOrTarball.test.js +0 -74
  592. package/dist/util/__tests__/extractDocumentsFromNdjsonOrTarball.test.js.map +0 -1
  593. package/dist/util/__tests__/findNdjsonEntry.test.js +0 -54
  594. package/dist/util/__tests__/findNdjsonEntry.test.js.map +0 -1
  595. package/dist/util/__tests__/getCliVersion.test.js +0 -28
  596. package/dist/util/__tests__/getCliVersion.test.js.map +0 -1
  597. package/dist/util/__tests__/getLocalPackageVersion.test.js +0 -84
  598. package/dist/util/__tests__/getLocalPackageVersion.test.js.map +0 -1
  599. package/dist/util/__tests__/getWorkspace.test.js +0 -37
  600. package/dist/util/__tests__/getWorkspace.test.js.map +0 -1
  601. package/dist/util/__tests__/readPackageJson.test.js +0 -69
  602. package/dist/util/__tests__/readPackageJson.test.js.map +0 -1
  603. package/dist/util/__tests__/warnAboutMissingAppId.test.js +0 -28
  604. package/dist/util/__tests__/warnAboutMissingAppId.test.js.map +0 -1
  605. package/dist/util/packageManager/__tests__/installPackages.test.js +0 -388
  606. package/dist/util/packageManager/__tests__/installPackages.test.js.map +0 -1
  607. package/dist/util/validation/ __tests__/validateDocuments.test.js +0 -274
  608. package/dist/util/validation/ __tests__/validateDocuments.test.js.map +0 -1
@@ -1,967 +0,0 @@
1
- import { randomUUID } from 'node:crypto';
2
- import fs from 'node:fs/promises';
3
- import os from 'node:os';
4
- import path from 'node:path';
5
- import { runCommand } from '@oclif/test';
6
- import { getCliConfig, getProjectCliClient } from '@sanity/cli-core';
7
- import { testCommand } from '@sanity/cli-test';
8
- import { watch as chokidarWatch } from 'chokidar';
9
- import { execa, execaSync } from 'execa';
10
- import json5 from 'json5';
11
- import { afterEach, describe, expect, test, vi } from 'vitest';
12
- import { NO_PROJECT_ID } from '../../../util/errorMessages.js';
13
- import { CreateDocumentCommand } from '../create.js';
14
- vi.mock('node:fs/promises');
15
- vi.mock('node:os');
16
- vi.mock('chokidar', ()=>({
17
- watch: vi.fn()
18
- }));
19
- vi.mock('execa');
20
- vi.mock('json5');
21
- vi.mock('node:crypto', async ()=>{
22
- return {
23
- randomUUID: vi.fn()
24
- };
25
- });
26
- vi.mock('../../../../../cli-core/src/config/findProjectRoot.js', ()=>({
27
- findProjectRoot: vi.fn().mockResolvedValue({
28
- directory: '/test/path',
29
- root: '/test/path',
30
- type: 'studio'
31
- })
32
- }));
33
- vi.mock('../../../../../cli-core/src/config/cli/getCliConfig.js', ()=>({
34
- getCliConfig: vi.fn()
35
- }));
36
- vi.mock('../../../../../cli-core/src/services/getCliToken.js', ()=>({
37
- getCliToken: vi.fn().mockResolvedValue('test-token')
38
- }));
39
- vi.mock('../../../../../cli-core/src/services/apiClient.js', ()=>({
40
- getProjectCliClient: vi.fn()
41
- }));
42
- const mockGetCliConfig = vi.mocked(getCliConfig);
43
- const mockGetProjectCliClient = vi.mocked(getProjectCliClient);
44
- const mockFs = vi.mocked(fs);
45
- const mockOs = vi.mocked(os);
46
- const mockChokidarWatch = vi.mocked(chokidarWatch);
47
- const mockExeca = vi.mocked(execa);
48
- const mockExecaSync = vi.mocked(execaSync);
49
- const mockJson5 = vi.mocked(json5);
50
- const mockRandomUUID = vi.mocked(randomUUID);
51
- const testProjectId = 'test-project';
52
- const testDataset = 'production';
53
- // Helper to set environment variable for tests
54
- function withEditorEnv(testFn) {
55
- return async ()=>{
56
- vi.stubEnv('EDITOR', 'vim');
57
- try {
58
- await testFn();
59
- } finally{
60
- vi.unstubAllEnvs();
61
- }
62
- };
63
- }
64
- // Base configuration used across tests
65
- const baseConfig = {
66
- api: {
67
- dataset: testDataset,
68
- projectId: testProjectId
69
- }
70
- };
71
- // Helper functions moved to outer scope to fix linting
72
- const setupBaseMocks = (additionalConfig = {})=>{
73
- mockGetCliConfig.mockResolvedValue({
74
- ...baseConfig,
75
- ...additionalConfig
76
- });
77
- };
78
- const setupMocks = ()=>{
79
- setupBaseMocks();
80
- const mockClient = {
81
- transaction: vi.fn().mockReturnValue({
82
- commit: vi.fn().mockResolvedValue({
83
- results: [
84
- {
85
- id: 'test-doc',
86
- operation: 'create'
87
- }
88
- ]
89
- })
90
- })
91
- };
92
- mockGetProjectCliClient.mockResolvedValue(mockClient);
93
- return mockClient;
94
- };
95
- const setupEditorMocks = ()=>{
96
- setupBaseMocks();
97
- mockOs.tmpdir.mockReturnValue('/tmp');
98
- mockFs.mkdir.mockResolvedValue(undefined);
99
- mockFs.writeFile.mockResolvedValue(undefined);
100
- mockFs.unlink.mockResolvedValue(undefined);
101
- mockExecaSync.mockReturnValue(undefined);
102
- };
103
- const setupWatchMocks = ()=>{
104
- setupBaseMocks();
105
- mockOs.tmpdir.mockReturnValue('/tmp');
106
- mockFs.mkdir.mockResolvedValue(undefined);
107
- mockFs.writeFile.mockResolvedValue(undefined);
108
- mockFs.unlink.mockResolvedValue(undefined);
109
- };
110
- describe('#documents:create', ()=>{
111
- afterEach(()=>{
112
- vi.clearAllMocks();
113
- });
114
- test('--help works', async ()=>{
115
- const { stdout } = await runCommand([
116
- 'documents create',
117
- '--help'
118
- ]);
119
- expect(stdout).toMatchInlineSnapshot(`
120
- "Create one or more documents
121
-
122
- USAGE
123
- $ sanity documents create [FILE] [-d <value>] [--id <value>] [--json5]
124
- [--missing] [--replace] [--watch]
125
-
126
- ARGUMENTS
127
- [FILE] JSON file to create document(s) from
128
-
129
- FLAGS
130
- -d, --dataset=<value> Dataset to create document(s) in (overrides config)
131
- --id=<value> Specify a document ID to use. Will fetch remote
132
- document ID and populate editor.
133
- --json5 Use JSON5 file type to allow a "simplified" version of
134
- JSON
135
- --missing On duplicate document IDs, don't modify the target
136
- document(s)
137
- --replace On duplicate document IDs, replace existing document
138
- with specified document(s)
139
- --watch Write the documents whenever the target file or buffer
140
- changes
141
-
142
- DESCRIPTION
143
- Create one or more documents
144
-
145
- EXAMPLES
146
- Create the document specified in "myDocument.json"
147
-
148
- $ sanity documents create myDocument.json
149
-
150
- Open configured $EDITOR and create the specified document(s)
151
-
152
- $ sanity documents create
153
-
154
- Fetch document with the ID "myDocId" and open configured $EDITOR with the
155
- current document content (if any). Replace document with the edited version
156
- when the editor closes
157
-
158
- $ sanity documents create --id myDocId --replace
159
-
160
- Open configured $EDITOR and replace the document with the given content on
161
- each save. Use JSON5 file extension and parser for simplified syntax.
162
-
163
- $ sanity documents create --id myDocId --watch --replace --json5
164
-
165
- "
166
- `);
167
- });
168
- test('creates document from JSON file and displays success message', async ()=>{
169
- const mockDoc = {
170
- _id: 'test-doc',
171
- _type: 'post',
172
- title: 'Test Post'
173
- };
174
- const mockTransaction = {
175
- commit: vi.fn().mockResolvedValue({
176
- results: [
177
- {
178
- id: 'test-doc',
179
- operation: 'create'
180
- }
181
- ]
182
- })
183
- };
184
- mockGetCliConfig.mockResolvedValue({
185
- api: {
186
- dataset: testDataset,
187
- projectId: testProjectId
188
- }
189
- });
190
- const mockClient = {
191
- transaction: vi.fn().mockReturnValue(mockTransaction)
192
- };
193
- mockGetProjectCliClient.mockResolvedValue(mockClient);
194
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
195
- mockJson5.parse.mockReturnValue(mockDoc);
196
- const { stdout } = await testCommand(CreateDocumentCommand, [
197
- 'test-doc.json'
198
- ]);
199
- expect(stdout).toContain('Created:');
200
- expect(stdout).toContain('test-doc');
201
- expect(mockFs.readFile).toHaveBeenCalledWith(path.resolve(process.cwd(), 'test-doc.json'), 'utf8');
202
- expect(mockClient.transaction).toHaveBeenCalledWith([
203
- {
204
- create: mockDoc
205
- }
206
- ]);
207
- });
208
- test('creates document with replace flag', async ()=>{
209
- const mockDoc = {
210
- _id: 'test-doc',
211
- _type: 'post',
212
- title: 'Test Post'
213
- };
214
- const mockTransaction = {
215
- commit: vi.fn().mockResolvedValue({
216
- results: [
217
- {
218
- id: 'test-doc',
219
- operation: 'update'
220
- }
221
- ]
222
- })
223
- };
224
- mockGetCliConfig.mockResolvedValue({
225
- api: {
226
- dataset: testDataset,
227
- projectId: testProjectId
228
- }
229
- });
230
- const mockClient = {
231
- transaction: vi.fn().mockReturnValue(mockTransaction)
232
- };
233
- mockGetProjectCliClient.mockResolvedValue(mockClient);
234
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
235
- mockJson5.parse.mockReturnValue(mockDoc);
236
- const { stdout } = await testCommand(CreateDocumentCommand, [
237
- 'test-doc.json',
238
- '--replace'
239
- ]);
240
- expect(stdout).toContain('Upserted:');
241
- expect(stdout).toContain('test-doc');
242
- expect(mockClient.transaction).toHaveBeenCalledWith([
243
- {
244
- createOrReplace: mockDoc
245
- }
246
- ]);
247
- });
248
- test('creates document with missing flag', async ()=>{
249
- const mockDoc = {
250
- _id: 'test-doc',
251
- _type: 'post',
252
- title: 'Test Post'
253
- };
254
- const mockTransaction = {
255
- commit: vi.fn().mockResolvedValue({
256
- results: [
257
- {
258
- id: 'test-doc',
259
- operation: 'update'
260
- }
261
- ]
262
- })
263
- };
264
- mockGetCliConfig.mockResolvedValue({
265
- api: {
266
- dataset: testDataset,
267
- projectId: testProjectId
268
- }
269
- });
270
- const mockClient = {
271
- transaction: vi.fn().mockReturnValue(mockTransaction)
272
- };
273
- mockGetProjectCliClient.mockResolvedValue(mockClient);
274
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
275
- mockJson5.parse.mockReturnValue(mockDoc);
276
- const { stdout } = await testCommand(CreateDocumentCommand, [
277
- 'test-doc.json',
278
- '--missing'
279
- ]);
280
- expect(stdout).toContain('Skipped (already exists):');
281
- expect(stdout).toContain('test-doc');
282
- expect(mockClient.transaction).toHaveBeenCalledWith([
283
- {
284
- createIfNotExists: mockDoc
285
- }
286
- ]);
287
- });
288
- test('opens editor when no file specified and creates document from editor content', withEditorEnv(async ()=>{
289
- mockGetCliConfig.mockResolvedValue({
290
- api: {
291
- dataset: testDataset,
292
- projectId: testProjectId
293
- }
294
- });
295
- const mockClient = {
296
- getDocument: vi.fn().mockResolvedValue(null),
297
- transaction: vi.fn().mockReturnValue({
298
- commit: vi.fn().mockResolvedValue({
299
- results: [
300
- {
301
- id: 'generated-id',
302
- operation: 'create'
303
- }
304
- ]
305
- })
306
- })
307
- };
308
- mockGetProjectCliClient.mockResolvedValue(mockClient);
309
- mockOs.tmpdir.mockReturnValue('/tmp');
310
- mockFs.mkdir.mockResolvedValue(undefined);
311
- mockFs.writeFile.mockResolvedValue(undefined);
312
- mockFs.readFile.mockResolvedValue('{"_id": "generated-id", "_type": "updated-type"}');
313
- mockFs.unlink.mockResolvedValue(undefined);
314
- mockJson5.stringify.mockReturnValue('{"_id": "generated-id", "_type": "specify-me"}');
315
- mockJson5.parse.mockReturnValue({
316
- _id: 'generated-id',
317
- _type: 'updated-type'
318
- });
319
- mockExecaSync.mockReturnValue(undefined);
320
- const { stdout } = await testCommand(CreateDocumentCommand, []);
321
- expect(stdout).toContain('Created:');
322
- expect(mockFs.mkdir).toHaveBeenCalledWith('/tmp/sanity-cli', {
323
- mode: 0o700,
324
- recursive: true
325
- });
326
- expect(mockExecaSync).toHaveBeenCalled();
327
- }));
328
- test('uses custom dataset from --dataset flag instead of config', async ()=>{
329
- const mockDoc = {
330
- _id: 'test-doc',
331
- _type: 'post',
332
- title: 'Test Post'
333
- };
334
- setupMocks();
335
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
336
- mockJson5.parse.mockReturnValue(mockDoc);
337
- const { stdout } = await testCommand(CreateDocumentCommand, [
338
- 'test-doc.json',
339
- '--dataset',
340
- 'staging'
341
- ]);
342
- expect(stdout).toContain('Created:');
343
- expect(mockGetProjectCliClient).toHaveBeenCalledWith(expect.objectContaining({
344
- dataset: 'staging'
345
- }));
346
- });
347
- test('throws error when both --replace and --missing flags are used', async ()=>{
348
- setupBaseMocks();
349
- const { error } = await testCommand(CreateDocumentCommand, [
350
- 'test-doc.json',
351
- '--replace',
352
- '--missing'
353
- ]);
354
- expect(error).toBeInstanceOf(Error);
355
- expect(error?.message).toContain('Cannot use both --replace and --missing');
356
- expect(error?.oclif?.exit).toBe(1);
357
- });
358
- test('throws error when --id and file path are both provided', async ()=>{
359
- setupBaseMocks();
360
- const { error } = await testCommand(CreateDocumentCommand, [
361
- 'test-doc.json',
362
- '--id',
363
- 'myDocId'
364
- ]);
365
- expect(error).toBeInstanceOf(Error);
366
- expect(error?.message).toContain('Cannot use --id when specifying a file path');
367
- expect(error?.oclif?.exit).toBe(1);
368
- });
369
- test('throws error when no project ID is configured', async ()=>{
370
- mockGetCliConfig.mockResolvedValue({
371
- api: {
372
- dataset: 'production',
373
- projectId: undefined
374
- }
375
- });
376
- const { error } = await testCommand(CreateDocumentCommand, [
377
- 'test-doc.json'
378
- ]);
379
- expect(error).toBeInstanceOf(Error);
380
- expect(error?.message).toEqual(NO_PROJECT_ID);
381
- expect(error?.oclif?.exit).toBe(1);
382
- });
383
- test('throws error when no dataset is configured and none provided', async ()=>{
384
- mockGetCliConfig.mockResolvedValue({
385
- api: {
386
- dataset: undefined,
387
- projectId: testProjectId
388
- }
389
- });
390
- const { error } = await testCommand(CreateDocumentCommand, [
391
- 'test-doc.json'
392
- ]);
393
- expect(error).toBeInstanceOf(Error);
394
- expect(error?.message).toContain('No dataset specified');
395
- expect(error?.oclif?.exit).toBe(1);
396
- });
397
- test('displays error message when file cannot be read', async ()=>{
398
- setupBaseMocks();
399
- mockGetProjectCliClient.mockResolvedValue({});
400
- mockFs.readFile.mockRejectedValue(new Error('File not found'));
401
- const { error } = await testCommand(CreateDocumentCommand, [
402
- 'nonexistent.json'
403
- ]);
404
- expect(error).toBeInstanceOf(Error);
405
- expect(error?.message).toContain('Failed to create documents');
406
- expect(error?.oclif?.exit).toBe(1);
407
- });
408
- test('validates document has required _type property', async ()=>{
409
- const invalidDoc = {
410
- title: 'Test Post'
411
- } // Missing _type
412
- ;
413
- setupBaseMocks();
414
- mockGetProjectCliClient.mockResolvedValue({});
415
- mockFs.readFile.mockResolvedValue(JSON.stringify(invalidDoc));
416
- mockJson5.parse.mockReturnValue(invalidDoc);
417
- const { error } = await testCommand(CreateDocumentCommand, [
418
- 'invalid-doc.json'
419
- ]);
420
- expect(error).toBeInstanceOf(Error);
421
- expect(error?.message).toContain('Failed to create documents');
422
- expect(error?.oclif?.exit).toBe(1);
423
- });
424
- test('uses JSON5 when --json5 flag is provided', withEditorEnv(async ()=>{
425
- mockGetCliConfig.mockResolvedValue({
426
- api: {
427
- dataset: testDataset,
428
- projectId: testProjectId
429
- }
430
- });
431
- const mockClient = {
432
- getDocument: vi.fn().mockResolvedValue(null),
433
- transaction: vi.fn().mockReturnValue({
434
- commit: vi.fn().mockResolvedValue({
435
- results: [
436
- {
437
- id: 'generated-id',
438
- operation: 'create'
439
- }
440
- ]
441
- })
442
- })
443
- };
444
- mockGetProjectCliClient.mockResolvedValue(mockClient);
445
- mockOs.tmpdir.mockReturnValue('/tmp');
446
- mockFs.mkdir.mockResolvedValue(undefined);
447
- mockFs.writeFile.mockResolvedValue(undefined);
448
- mockFs.readFile.mockResolvedValue('{"_id": "generated-id", "_type": "updated-type"}');
449
- mockFs.unlink.mockResolvedValue(undefined);
450
- mockJson5.stringify.mockReturnValue('{"_id": "generated-id", "_type": "specify-me"}');
451
- mockJson5.parse.mockReturnValue({
452
- _id: 'generated-id',
453
- _type: 'updated-type'
454
- });
455
- mockExecaSync.mockReturnValue(undefined);
456
- await testCommand(CreateDocumentCommand, [
457
- '--json5'
458
- ]);
459
- expect(mockJson5.stringify).toHaveBeenCalled();
460
- expect(mockFs.writeFile).toHaveBeenCalledWith(expect.stringContaining('.json5'), expect.any(String), {
461
- encoding: 'utf8',
462
- mode: 0o600
463
- });
464
- }));
465
- describe('validation', ()=>{
466
- test.each([
467
- [
468
- 'non-object document',
469
- 'not an object',
470
- 'Document must be an object'
471
- ],
472
- [
473
- 'document without _type',
474
- {
475
- title: 'Test'
476
- },
477
- 'Document must have a `_type` property of type string'
478
- ],
479
- [
480
- 'document with empty _type',
481
- {
482
- _type: '',
483
- title: 'Test'
484
- },
485
- 'Document _type cannot be empty'
486
- ],
487
- [
488
- 'document with invalid _type format (starts with number)',
489
- {
490
- _type: '1invalid',
491
- title: 'Test'
492
- },
493
- 'Document _type must start with a letter'
494
- ],
495
- [
496
- 'document with invalid _type format (special chars)',
497
- {
498
- _type: 'invalid@type',
499
- title: 'Test'
500
- },
501
- 'Document _type must start with a letter and contain only alphanumeric characters'
502
- ],
503
- [
504
- 'document with empty _id',
505
- {
506
- _id: ' ',
507
- _type: 'test',
508
- title: 'Test'
509
- },
510
- 'Document _id cannot be empty'
511
- ],
512
- [
513
- 'document with invalid _id format',
514
- {
515
- _id: 'invalid@id',
516
- _type: 'test',
517
- title: 'Test'
518
- },
519
- 'Document _id can only contain alphanumeric characters'
520
- ],
521
- [
522
- 'document with _id too long',
523
- {
524
- _id: 'a'.repeat(201),
525
- _type: 'test',
526
- title: 'Test'
527
- },
528
- 'Document _id cannot be longer than 200 characters'
529
- ]
530
- ])('validates %s', async (description, doc, expectedErrorSubstring)=>{
531
- setupMocks();
532
- mockFs.readFile.mockResolvedValue(JSON.stringify(doc));
533
- mockJson5.parse.mockReturnValue(doc);
534
- const { error } = await testCommand(CreateDocumentCommand, [
535
- 'invalid-doc.json'
536
- ]);
537
- expect(error).toBeInstanceOf(Error);
538
- expect(error?.message).toContain(expectedErrorSubstring);
539
- expect(error?.oclif?.exit).toBe(1);
540
- });
541
- test.each([
542
- [
543
- 'multiple documents with invalid first document',
544
- [
545
- {
546
- title: 'Invalid'
547
- },
548
- {
549
- _type: 'valid',
550
- title: 'Valid'
551
- }
552
- ],
553
- 'Document at index 0 must have a `_type` property of type string'
554
- ],
555
- [
556
- 'multiple documents with invalid second document',
557
- [
558
- {
559
- _type: 'valid',
560
- title: 'Valid'
561
- },
562
- {
563
- title: 'Invalid'
564
- }
565
- ],
566
- 'Document at index 1 must have a `_type` property of type string'
567
- ]
568
- ])('validates %s', async (description, docs, expectedErrorSubstring)=>{
569
- setupMocks();
570
- mockFs.readFile.mockResolvedValue(JSON.stringify(docs));
571
- mockJson5.parse.mockReturnValue(docs);
572
- const { error } = await testCommand(CreateDocumentCommand, [
573
- 'invalid-docs.json'
574
- ]);
575
- expect(error).toBeInstanceOf(Error);
576
- expect(error?.message).toContain(expectedErrorSubstring);
577
- expect(error?.oclif?.exit).toBe(1);
578
- });
579
- test('allows documents with reserved fields but logs debug warning', async ()=>{
580
- const docWithReservedFields = {
581
- _createdAt: '2024-01-01T00:00:00Z',
582
- _id: 'test-doc',
583
- _rev: 'some-revision',
584
- _type: 'post',
585
- _updatedAt: '2024-01-02T00:00:00Z',
586
- title: 'Test Post'
587
- };
588
- setupMocks();
589
- const mockClient = {
590
- transaction: vi.fn().mockReturnValue({
591
- commit: vi.fn().mockResolvedValue({
592
- results: [
593
- {
594
- id: 'test-doc',
595
- operation: 'create'
596
- }
597
- ]
598
- })
599
- })
600
- };
601
- mockGetProjectCliClient.mockResolvedValue(mockClient);
602
- mockFs.readFile.mockResolvedValue(JSON.stringify(docWithReservedFields));
603
- mockJson5.parse.mockReturnValue(docWithReservedFields);
604
- // Should not throw error, but should proceed with document creation
605
- const { stdout } = await testCommand(CreateDocumentCommand, [
606
- 'doc.json'
607
- ]);
608
- expect(stdout).toContain('Created:');
609
- expect(stdout).toContain('test-doc');
610
- expect(mockClient.transaction).toHaveBeenCalledWith([
611
- {
612
- create: docWithReservedFields
613
- }
614
- ]);
615
- });
616
- test('validates empty document array throws error', async ()=>{
617
- const emptyArray = [];
618
- setupMocks();
619
- mockFs.readFile.mockResolvedValue(JSON.stringify(emptyArray));
620
- mockJson5.parse.mockReturnValue(emptyArray);
621
- const { error } = await testCommand(CreateDocumentCommand, [
622
- 'empty-docs.json'
623
- ]);
624
- expect(error).toBeInstanceOf(Error);
625
- expect(error?.message).toContain('No documents provided');
626
- expect(error?.oclif?.exit).toBe(1);
627
- });
628
- });
629
- describe('batch operations', ()=>{
630
- test.each([
631
- [
632
- 'create',
633
- 'create',
634
- 'Created:'
635
- ],
636
- [
637
- 'createOrReplace',
638
- 'replace',
639
- 'Upserted:'
640
- ],
641
- [
642
- 'createIfNotExists',
643
- 'missing',
644
- 'Skipped (already exists):'
645
- ]
646
- ])('handles multiple documents with %s operation', async (operation, flag, expectedMessage)=>{
647
- const mockDocs = [
648
- {
649
- _id: 'doc1',
650
- _type: 'post',
651
- title: 'Post 1'
652
- },
653
- {
654
- _id: 'doc2',
655
- _type: 'post',
656
- title: 'Post 2'
657
- }
658
- ];
659
- const mockTransaction = {
660
- commit: vi.fn().mockResolvedValue({
661
- results: [
662
- {
663
- id: 'doc1',
664
- operation: operation === 'createIfNotExists' ? 'update' : 'create'
665
- },
666
- {
667
- id: 'doc2',
668
- operation: operation === 'createIfNotExists' ? 'update' : 'create'
669
- }
670
- ]
671
- })
672
- };
673
- setupMocks();
674
- const mockClient = {
675
- transaction: vi.fn().mockReturnValue(mockTransaction)
676
- };
677
- mockGetProjectCliClient.mockResolvedValue(mockClient);
678
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDocs));
679
- mockJson5.parse.mockReturnValue(mockDocs);
680
- const args = [
681
- 'docs.json'
682
- ];
683
- if (flag !== 'create') args.push(`--${flag}`);
684
- const { stdout } = await testCommand(CreateDocumentCommand, args);
685
- expect(stdout).toContain(expectedMessage);
686
- expect(stdout).toContain('doc1');
687
- expect(stdout).toContain('doc2');
688
- const expectedMutations = mockDocs.map((doc)=>({
689
- [operation]: doc
690
- }));
691
- expect(mockClient.transaction).toHaveBeenCalledWith(expectedMutations);
692
- });
693
- test('handles mixed results for createIfNotExists', async ()=>{
694
- const mockDocs = [
695
- {
696
- _id: 'doc1',
697
- _type: 'post',
698
- title: 'Post 1'
699
- },
700
- {
701
- _id: 'doc2',
702
- _type: 'post',
703
- title: 'Post 2'
704
- },
705
- {
706
- _id: 'doc3',
707
- _type: 'post',
708
- title: 'Post 3'
709
- }
710
- ];
711
- const mockTransaction = {
712
- commit: vi.fn().mockResolvedValue({
713
- results: [
714
- {
715
- id: 'doc1',
716
- operation: 'create'
717
- },
718
- {
719
- id: 'doc2',
720
- operation: 'update'
721
- },
722
- {
723
- id: 'doc3',
724
- operation: 'create'
725
- }
726
- ]
727
- })
728
- };
729
- setupMocks();
730
- const mockClient = {
731
- transaction: vi.fn().mockReturnValue(mockTransaction)
732
- };
733
- mockGetProjectCliClient.mockResolvedValue(mockClient);
734
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDocs));
735
- mockJson5.parse.mockReturnValue(mockDocs);
736
- const { stdout } = await testCommand(CreateDocumentCommand, [
737
- 'docs.json',
738
- '--missing'
739
- ]);
740
- expect(stdout).toContain('Created:');
741
- expect(stdout).toContain('doc1');
742
- expect(stdout).toContain('doc3');
743
- expect(stdout).toContain('Skipped (already exists):');
744
- expect(stdout).toContain('doc2');
745
- });
746
- });
747
- describe('editor workflow', ()=>{
748
- test('fetches existing document with --id flag', withEditorEnv(async ()=>{
749
- const existingDoc = {
750
- _id: 'existing-doc',
751
- _type: 'post',
752
- title: 'Existing Post'
753
- };
754
- const mockClient = {
755
- getDocument: vi.fn().mockResolvedValue(existingDoc),
756
- transaction: vi.fn().mockReturnValue({
757
- commit: vi.fn().mockResolvedValue({
758
- results: [
759
- {
760
- id: 'existing-doc',
761
- operation: 'update'
762
- }
763
- ]
764
- })
765
- })
766
- };
767
- mockGetProjectCliClient.mockResolvedValue(mockClient);
768
- setupEditorMocks();
769
- mockFs.readFile.mockResolvedValue(JSON.stringify({
770
- ...existingDoc,
771
- title: 'Updated Post'
772
- }));
773
- mockJson5.parse.mockReturnValue({
774
- ...existingDoc,
775
- title: 'Updated Post'
776
- });
777
- mockJson5.stringify.mockReturnValue(JSON.stringify(existingDoc, null, 2));
778
- const { stdout } = await testCommand(CreateDocumentCommand, [
779
- '--id',
780
- 'existing-doc'
781
- ]);
782
- expect(mockClient.getDocument).toHaveBeenCalledWith('existing-doc');
783
- expect(mockFs.writeFile).toHaveBeenCalledWith(expect.stringContaining('existing-doc.json'), JSON.stringify(existingDoc, null, 2), expect.objectContaining({
784
- mode: 0o600
785
- }));
786
- expect(stdout).toContain('Created:');
787
- }));
788
- test('handles no changes made in editor', withEditorEnv(async ()=>{
789
- const mockClient = {
790
- getDocument: vi.fn().mockResolvedValue(null),
791
- transaction: vi.fn()
792
- };
793
- mockGetProjectCliClient.mockResolvedValue(mockClient);
794
- setupEditorMocks();
795
- // Set up a predictable UUID so the test can verify no changes were made
796
- const testUuid = '123e4567-e89b-12d3-a456-426614174000';
797
- mockRandomUUID.mockReturnValue(testUuid);
798
- const defaultDoc = {
799
- _id: testUuid,
800
- _type: 'specify-me'
801
- };
802
- // First mock the writeFile call for initial template
803
- const writeFileContent = JSON.stringify(defaultDoc, null, 2);
804
- mockJson5.stringify.mockReturnValue(writeFileContent);
805
- // Set up the file read to return the exact same content structure
806
- mockFs.readFile.mockResolvedValue(writeFileContent);
807
- // Return the exact same object structure that was written
808
- mockJson5.parse.mockReturnValue(defaultDoc);
809
- await testCommand(CreateDocumentCommand, []);
810
- // The key test - transaction should not have been called since no changes were made
811
- expect(mockClient.transaction).not.toHaveBeenCalled();
812
- }));
813
- test('handles write error with already exists hint', withEditorEnv(async ()=>{
814
- const mockDoc = {
815
- _id: 'test-doc',
816
- _type: 'post',
817
- title: 'Test Post'
818
- };
819
- const mockClient = {
820
- getDocument: vi.fn().mockResolvedValue(null),
821
- transaction: vi.fn().mockReturnValue({
822
- commit: vi.fn().mockRejectedValue(new Error('Document already exists'))
823
- })
824
- };
825
- mockGetProjectCliClient.mockResolvedValue(mockClient);
826
- setupEditorMocks();
827
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
828
- mockJson5.parse.mockReturnValue(mockDoc);
829
- mockJson5.stringify.mockReturnValue(JSON.stringify({
830
- _id: 'test-doc',
831
- _type: 'specify-me'
832
- }, null, 2));
833
- const { error } = await testCommand(CreateDocumentCommand, []);
834
- expect(error).toBeInstanceOf(Error);
835
- expect(error?.message).toContain('Failed to write documents: Document already exists');
836
- expect(error?.message).toContain('Perhaps you want to use `--replace` or `--missing`?');
837
- expect(error?.oclif?.exit).toBe(1);
838
- }));
839
- test('handles file cleanup errors silently', withEditorEnv(async ()=>{
840
- const mockDoc = {
841
- _id: 'test-doc',
842
- _type: 'post',
843
- title: 'Test Post'
844
- };
845
- const mockClient = {
846
- getDocument: vi.fn().mockResolvedValue(null),
847
- transaction: vi.fn().mockReturnValue({
848
- commit: vi.fn().mockResolvedValue({
849
- results: [
850
- {
851
- id: 'test-doc',
852
- operation: 'create'
853
- }
854
- ]
855
- })
856
- })
857
- };
858
- mockGetProjectCliClient.mockResolvedValue(mockClient);
859
- setupEditorMocks();
860
- // Mock unlink to throw an error (should be caught silently)
861
- mockFs.unlink.mockRejectedValue(new Error('Permission denied'));
862
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
863
- mockJson5.parse.mockReturnValue(mockDoc);
864
- mockJson5.stringify.mockReturnValue(JSON.stringify({
865
- _id: 'test-doc',
866
- _type: 'specify-me'
867
- }, null, 2));
868
- const { stdout } = await testCommand(CreateDocumentCommand, []);
869
- // Should still succeed despite file cleanup error
870
- expect(stdout).toContain('Created:');
871
- expect(stdout).toContain('test-doc');
872
- expect(mockFs.unlink).toHaveBeenCalled();
873
- }));
874
- });
875
- describe('watch mode', ()=>{
876
- test('enables watch mode and logs appropriate messages', withEditorEnv(async ()=>{
877
- const mockWatcher = {
878
- on: vi.fn().mockReturnThis()
879
- };
880
- mockChokidarWatch.mockReturnValue(mockWatcher);
881
- const mockClient = {
882
- getDocument: vi.fn().mockResolvedValue(null),
883
- transaction: vi.fn().mockReturnValue({
884
- commit: vi.fn().mockResolvedValue({
885
- results: [
886
- {
887
- id: 'test-doc',
888
- operation: 'create'
889
- }
890
- ]
891
- })
892
- })
893
- };
894
- mockGetProjectCliClient.mockResolvedValue(mockClient);
895
- setupWatchMocks();
896
- mockJson5.stringify.mockReturnValue(JSON.stringify({
897
- _id: 'test-doc',
898
- _type: 'specify-me'
899
- }, null, 2));
900
- mockExeca.mockResolvedValue({});
901
- const { stdout } = await testCommand(CreateDocumentCommand, [
902
- '--watch'
903
- ]);
904
- expect(stdout).toContain('Watch mode:');
905
- expect(stdout).toContain('Will write documents on each save.');
906
- expect(stdout).toContain('Press Ctrl + C to cancel watch mode.');
907
- expect(mockWatcher.on).toHaveBeenCalledWith('change', expect.any(Function));
908
- expect(mockExeca).toHaveBeenCalledWith('vim', expect.any(Array), {
909
- stdio: 'inherit'
910
- });
911
- expect(mockChokidarWatch).toHaveBeenCalledWith(expect.stringContaining('.json'));
912
- }));
913
- test('handles file change events in watch mode', withEditorEnv(async ()=>{
914
- const mockDoc = {
915
- _id: 'test-doc',
916
- _type: 'post',
917
- title: 'Updated Post'
918
- };
919
- let changeHandler;
920
- const mockWatcher = {
921
- on: vi.fn().mockImplementation((event, handler)=>{
922
- if (event === 'change') {
923
- changeHandler = handler;
924
- }
925
- return mockWatcher;
926
- })
927
- };
928
- mockChokidarWatch.mockReturnValue(mockWatcher);
929
- const mockClient = {
930
- getDocument: vi.fn().mockResolvedValue(null),
931
- transaction: vi.fn().mockReturnValue({
932
- commit: vi.fn().mockResolvedValue({
933
- results: [
934
- {
935
- id: 'test-doc',
936
- operation: 'create'
937
- }
938
- ]
939
- })
940
- })
941
- };
942
- mockGetProjectCliClient.mockResolvedValue(mockClient);
943
- setupWatchMocks();
944
- mockJson5.stringify.mockReturnValue(JSON.stringify({
945
- _id: 'test-doc',
946
- _type: 'specify-me'
947
- }, null, 2));
948
- mockExeca.mockResolvedValue({});
949
- // Mock file read to return different content for file change
950
- mockFs.readFile.mockResolvedValue(JSON.stringify(mockDoc));
951
- mockJson5.parse.mockReturnValue(mockDoc);
952
- await testCommand(CreateDocumentCommand, [
953
- '--watch'
954
- ]);
955
- // Simulate file change
956
- expect(changeHandler).toBeDefined();
957
- await changeHandler();
958
- expect(mockClient.transaction).toHaveBeenCalledWith([
959
- {
960
- create: mockDoc
961
- }
962
- ]);
963
- }));
964
- });
965
- });
966
-
967
- //# sourceMappingURL=create.test.js.map