prismic-ts-codegen 0.1.6 → 0.1.7

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 (175) hide show
  1. package/README.md +5 -5
  2. package/bin/prismic-ts-codegen.mjs +3 -0
  3. package/dist/cli/configSchema.cjs +38 -0
  4. package/dist/cli/configSchema.cjs.map +1 -0
  5. package/dist/cli/configSchema.d.ts +3 -0
  6. package/dist/cli/configSchema.js +38 -0
  7. package/dist/cli/configSchema.js.map +1 -0
  8. package/dist/cli/constants.cjs +5 -0
  9. package/dist/cli/constants.cjs.map +1 -0
  10. package/dist/cli/constants.d.ts +1 -0
  11. package/dist/cli/constants.js +5 -0
  12. package/dist/cli/constants.js.map +1 -0
  13. package/dist/cli/index.d.ts +1 -0
  14. package/dist/cli/loadConfig.cjs +32 -0
  15. package/dist/cli/loadConfig.cjs.map +1 -0
  16. package/dist/cli/loadConfig.d.ts +6 -0
  17. package/dist/cli/loadConfig.js +32 -0
  18. package/dist/cli/loadConfig.js.map +1 -0
  19. package/dist/cli/loadLocaleIDs.cjs +37 -0
  20. package/dist/cli/loadLocaleIDs.cjs.map +1 -0
  21. package/dist/cli/loadLocaleIDs.d.ts +10 -0
  22. package/dist/cli/loadLocaleIDs.js +20 -0
  23. package/dist/cli/loadLocaleIDs.js.map +1 -0
  24. package/dist/cli/loadModels.cjs +79 -0
  25. package/dist/cli/loadModels.cjs.map +1 -0
  26. package/dist/cli/loadModels.d.ts +15 -0
  27. package/dist/cli/loadModels.js +62 -0
  28. package/dist/cli/loadModels.js.map +1 -0
  29. package/dist/cli/types.d.ts +175 -0
  30. package/dist/cli.cjs +119 -0
  31. package/dist/cli.cjs.map +1 -0
  32. package/dist/cli.js +118 -0
  33. package/dist/cli.js.map +1 -0
  34. package/dist/constants.cjs +29 -0
  35. package/dist/constants.cjs.map +1 -0
  36. package/dist/constants.d.ts +5 -0
  37. package/dist/constants.js +29 -0
  38. package/dist/constants.js.map +1 -0
  39. package/dist/detectTypesProvider.cjs +16 -0
  40. package/dist/detectTypesProvider.cjs.map +1 -0
  41. package/dist/detectTypesProvider.d.ts +13 -0
  42. package/dist/detectTypesProvider.js +16 -0
  43. package/dist/detectTypesProvider.js.map +1 -0
  44. package/dist/generateTypes.cjs +109 -0
  45. package/dist/generateTypes.cjs.map +1 -0
  46. package/dist/generateTypes.d.ts +15 -0
  47. package/dist/generateTypes.js +109 -0
  48. package/dist/generateTypes.js.map +1 -0
  49. package/dist/index.cjs +6 -1086
  50. package/dist/index.cjs.map +1 -1
  51. package/dist/index.d.ts +5 -192
  52. package/dist/index.js +5 -1081
  53. package/dist/index.js.map +1 -1
  54. package/dist/lib/addInterfacePropertiesForFields.cjs +490 -0
  55. package/dist/lib/addInterfacePropertiesForFields.cjs.map +1 -0
  56. package/dist/lib/addInterfacePropertiesForFields.d.ts +21 -0
  57. package/dist/lib/addInterfacePropertiesForFields.js +490 -0
  58. package/dist/lib/addInterfacePropertiesForFields.js.map +1 -0
  59. package/dist/lib/addTypeAliasForCustomType.cjs +81 -0
  60. package/dist/lib/addTypeAliasForCustomType.cjs.map +1 -0
  61. package/dist/lib/addTypeAliasForCustomType.d.ts +11 -0
  62. package/dist/lib/addTypeAliasForCustomType.js +81 -0
  63. package/dist/lib/addTypeAliasForCustomType.js.map +1 -0
  64. package/dist/lib/addTypeAliasForSharedSlice.cjs +149 -0
  65. package/dist/lib/addTypeAliasForSharedSlice.cjs.map +1 -0
  66. package/dist/lib/addTypeAliasForSharedSlice.d.ts +10 -0
  67. package/dist/lib/addTypeAliasForSharedSlice.js +149 -0
  68. package/dist/lib/addTypeAliasForSharedSlice.js.map +1 -0
  69. package/dist/lib/buildFieldDocs.cjs +43 -0
  70. package/dist/lib/buildFieldDocs.cjs.map +1 -0
  71. package/dist/lib/buildFieldDocs.d.ts +14 -0
  72. package/dist/lib/buildFieldDocs.js +43 -0
  73. package/dist/lib/buildFieldDocs.js.map +1 -0
  74. package/dist/lib/buildSharedSliceInterfaceNamePart.cjs +8 -0
  75. package/dist/lib/buildSharedSliceInterfaceNamePart.cjs.map +1 -0
  76. package/dist/lib/buildSharedSliceInterfaceNamePart.d.ts +5 -0
  77. package/dist/lib/buildSharedSliceInterfaceNamePart.js +8 -0
  78. package/dist/lib/buildSharedSliceInterfaceNamePart.js.map +1 -0
  79. package/dist/lib/buildTypeName.cjs +12 -0
  80. package/dist/lib/buildTypeName.cjs.map +1 -0
  81. package/dist/lib/buildTypeName.d.ts +1 -0
  82. package/dist/lib/buildTypeName.js +12 -0
  83. package/dist/lib/buildTypeName.js.map +1 -0
  84. package/dist/lib/getAPIIDPath.cjs +23 -0
  85. package/dist/lib/getAPIIDPath.cjs.map +1 -0
  86. package/dist/lib/getAPIIDPath.d.ts +10 -0
  87. package/dist/lib/getAPIIDPath.js +23 -0
  88. package/dist/lib/getAPIIDPath.js.map +1 -0
  89. package/dist/lib/getFieldDocumentationURL.cjs +8 -0
  90. package/dist/lib/getFieldDocumentationURL.cjs.map +1 -0
  91. package/dist/lib/getFieldDocumentationURL.d.ts +6 -0
  92. package/dist/lib/getFieldDocumentationURL.js +8 -0
  93. package/dist/lib/getFieldDocumentationURL.js.map +1 -0
  94. package/dist/lib/getHumanReadableFieldPath.cjs +19 -0
  95. package/dist/lib/getHumanReadableFieldPath.cjs.map +1 -0
  96. package/dist/lib/getHumanReadableFieldPath.d.ts +10 -0
  97. package/dist/lib/getHumanReadableFieldPath.js +19 -0
  98. package/dist/lib/getHumanReadableFieldPath.js.map +1 -0
  99. package/dist/lib/getHumanReadableFieldType.cjs +37 -0
  100. package/dist/lib/getHumanReadableFieldType.cjs.map +1 -0
  101. package/dist/lib/getHumanReadableFieldType.d.ts +6 -0
  102. package/dist/lib/getHumanReadableFieldType.js +37 -0
  103. package/dist/lib/getHumanReadableFieldType.js.map +1 -0
  104. package/dist/lib/getHumanReadableModelName.cjs +24 -0
  105. package/dist/lib/getHumanReadableModelName.cjs.map +1 -0
  106. package/dist/lib/getHumanReadableModelName.d.ts +7 -0
  107. package/dist/lib/getHumanReadableModelName.js +24 -0
  108. package/dist/lib/getHumanReadableModelName.js.map +1 -0
  109. package/dist/lib/getSourceFileText.cjs +9 -0
  110. package/dist/lib/getSourceFileText.cjs.map +1 -0
  111. package/dist/lib/getSourceFileText.d.ts +2 -0
  112. package/dist/lib/getSourceFileText.js +9 -0
  113. package/dist/lib/getSourceFileText.js.map +1 -0
  114. package/dist/lib/hasOwnProperty.cjs +7 -0
  115. package/dist/lib/hasOwnProperty.cjs.map +1 -0
  116. package/dist/lib/hasOwnProperty.d.ts +10 -0
  117. package/dist/lib/hasOwnProperty.js +7 -0
  118. package/dist/lib/hasOwnProperty.js.map +1 -0
  119. package/dist/lib/isCustomTypeModel.cjs +7 -0
  120. package/dist/lib/isCustomTypeModel.cjs.map +1 -0
  121. package/dist/lib/isCustomTypeModel.d.ts +2 -0
  122. package/dist/lib/isCustomTypeModel.js +7 -0
  123. package/dist/lib/isCustomTypeModel.js.map +1 -0
  124. package/dist/lib/isCustomTypeModelField.cjs +7 -0
  125. package/dist/lib/isCustomTypeModelField.cjs.map +1 -0
  126. package/dist/lib/isCustomTypeModelField.d.ts +2 -0
  127. package/dist/lib/isCustomTypeModelField.js +7 -0
  128. package/dist/lib/isCustomTypeModelField.js.map +1 -0
  129. package/dist/lib/isCustomTypeModelSlice.cjs +9 -0
  130. package/dist/lib/isCustomTypeModelSlice.cjs.map +1 -0
  131. package/dist/lib/isCustomTypeModelSlice.d.ts +2 -0
  132. package/dist/lib/isCustomTypeModelSlice.js +9 -0
  133. package/dist/lib/isCustomTypeModelSlice.js.map +1 -0
  134. package/dist/lib/isSharedSliceModel.cjs +9 -0
  135. package/dist/lib/isSharedSliceModel.cjs.map +1 -0
  136. package/dist/lib/isSharedSliceModel.d.ts +2 -0
  137. package/dist/lib/isSharedSliceModel.js +9 -0
  138. package/dist/lib/isSharedSliceModel.js.map +1 -0
  139. package/dist/lib/pascalCase.cjs +8 -0
  140. package/dist/lib/pascalCase.cjs.map +1 -0
  141. package/dist/lib/pascalCase.d.ts +1 -0
  142. package/dist/lib/pascalCase.js +8 -0
  143. package/dist/lib/pascalCase.js.map +1 -0
  144. package/dist/lib/writeFieldDocsDescription.cjs +29 -0
  145. package/dist/lib/writeFieldDocsDescription.cjs.map +1 -0
  146. package/dist/lib/writeFieldDocsDescription.d.ts +13 -0
  147. package/dist/lib/writeFieldDocsDescription.js +29 -0
  148. package/dist/lib/writeFieldDocsDescription.js.map +1 -0
  149. package/dist/types.d.ts +14 -0
  150. package/package.json +45 -36
  151. package/src/cli/configSchema.ts +2 -0
  152. package/src/cli/index.ts +9 -5
  153. package/src/cli/loadConfig.ts +4 -2
  154. package/src/cli/loadModels.ts +3 -3
  155. package/src/cli/types.ts +10 -0
  156. package/src/constants.ts +6 -3
  157. package/src/detectTypesProvider.ts +32 -0
  158. package/src/generateTypes.ts +11 -6
  159. package/src/index.ts +4 -1
  160. package/src/lib/addInterfacePropertiesForFields.ts +27 -27
  161. package/src/lib/addTypeAliasForCustomType.ts +7 -5
  162. package/src/lib/addTypeAliasForSharedSlice.ts +5 -4
  163. package/src/lib/buildFieldDocs.ts +2 -1
  164. package/src/lib/getAPIIDPath.ts +3 -2
  165. package/src/lib/getFieldDocumentationURL.ts +1 -1
  166. package/src/lib/getHumanReadableFieldPath.ts +2 -1
  167. package/src/lib/getHumanReadableFieldType.ts +2 -2
  168. package/src/lib/getHumanReadableModelName.ts +1 -1
  169. package/src/lib/getSourceFileText.ts +1 -1
  170. package/src/lib/isCustomTypeModel.ts +1 -1
  171. package/src/lib/isCustomTypeModelField.ts +1 -1
  172. package/src/lib/isCustomTypeModelSlice.ts +1 -1
  173. package/src/lib/isSharedSliceModel.ts +1 -1
  174. package/src/types.ts +1 -1
  175. package/bin/cli.mjs +0 -1342
@@ -1,12 +1,14 @@
1
- import type { CustomTypeModel, CustomTypeModelField } from "@prismicio/types";
1
+ import type { CustomTypeModel, CustomTypeModelField } from "@prismicio/client";
2
2
  import type {
3
+ InterfaceDeclaration,
3
4
  SourceFile,
4
5
  TypeAliasDeclaration,
5
- InterfaceDeclaration,
6
6
  } from "ts-morph";
7
- import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants";
7
+
8
8
  import { FieldConfigs } from "../types";
9
9
 
10
+ import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants";
11
+
10
12
  import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
11
13
  import { buildTypeName } from "./buildTypeName";
12
14
 
@@ -88,10 +90,10 @@ export const addTypeAliasForCustomType = ({
88
90
  },
89
91
  ],
90
92
  type: hasUIDField
91
- ? `prismicT.PrismicDocumentWithUID<Simplify<${dataInterface.getName()}>, "${
93
+ ? `prismic.PrismicDocumentWithUID<Simplify<${dataInterface.getName()}>, "${
92
94
  model.id
93
95
  }", Lang>`
94
- : `prismicT.PrismicDocumentWithoutUID<Simplify<${dataInterface.getName()}>, "${
96
+ : `prismic.PrismicDocumentWithoutUID<Simplify<${dataInterface.getName()}>, "${
95
97
  model.id
96
98
  }", Lang>`,
97
99
  docs: [
@@ -1,13 +1,14 @@
1
- import type { SharedSliceModel } from "@prismicio/types";
1
+ import type { SharedSliceModel } from "@prismicio/client";
2
2
  import type {
3
3
  InterfaceDeclaration,
4
4
  SourceFile,
5
5
  TypeAliasDeclaration,
6
6
  } from "ts-morph";
7
7
 
8
- import { SHARED_SLICES_DOCUMENTATION_URL } from "../constants";
9
8
  import { FieldConfigs } from "../types";
10
9
 
10
+ import { SHARED_SLICES_DOCUMENTATION_URL } from "../constants";
11
+
11
12
  import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
12
13
  import { buildSharedSliceInterfaceNamePart } from "./buildSharedSliceInterfaceNamePart";
13
14
  import { buildTypeName } from "./buildTypeName";
@@ -125,7 +126,7 @@ export const addTypeAliasForSharedSlice = (
125
126
  buildSharedSliceInterfaceNamePart({ id: config.model.id }),
126
127
  variation.id,
127
128
  ),
128
- type: `prismicT.SharedSliceVariation<"${variation.id}", ${
129
+ type: `prismic.SharedSliceVariation<"${variation.id}", ${
129
130
  primaryInterface
130
131
  ? `Simplify<${primaryInterface.getName()}>`
131
132
  : "Record<string, never>"
@@ -177,7 +178,7 @@ export const addTypeAliasForSharedSlice = (
177
178
  name: buildTypeName(
178
179
  buildSharedSliceInterfaceNamePart({ id: config.model.id }),
179
180
  ),
180
- type: `prismicT.SharedSlice<"${
181
+ type: `prismic.SharedSlice<"${
181
182
  config.model.id
182
183
  }", ${variationsType.getName()}>`,
183
184
  docs: [
@@ -3,10 +3,11 @@ import type {
3
3
  CustomTypeModelField,
4
4
  CustomTypeModelSlice,
5
5
  SharedSliceModel,
6
- } from "@prismicio/types";
6
+ } from "@prismicio/client";
7
7
  import type { JSDocableNodeStructure } from "ts-morph";
8
8
 
9
9
  import { PathElement } from "../types";
10
+
10
11
  import { getAPIIDPath } from "./getAPIIDPath";
11
12
  import { getFieldDocumentationURL } from "./getFieldDocumentationURL";
12
13
  import { getHumanReadableFieldPath } from "./getHumanReadableFieldPath";
@@ -3,10 +3,11 @@ import type {
3
3
  CustomTypeModelField,
4
4
  CustomTypeModelSlice,
5
5
  SharedSliceModel,
6
- } from "@prismicio/types";
7
- import { CustomTypeModelFieldType } from "@prismicio/types";
6
+ } from "@prismicio/client";
7
+ import { CustomTypeModelFieldType } from "@prismicio/client";
8
8
 
9
9
  import { PathElement } from "../types";
10
+
10
11
  import { isCustomTypeModelField } from "./isCustomTypeModelField";
11
12
  import { isCustomTypeModelSlice } from "./isCustomTypeModelSlice";
12
13
  import { isSharedSliceModel } from "./isSharedSliceModel";
@@ -1,4 +1,4 @@
1
- import type { CustomTypeModelField } from "@prismicio/types";
1
+ import type { CustomTypeModelField } from "@prismicio/client";
2
2
 
3
3
  import { FIELD_DOCUMENTATION_URLS } from "../constants";
4
4
 
@@ -3,9 +3,10 @@ import type {
3
3
  CustomTypeModelField,
4
4
  CustomTypeModelSlice,
5
5
  SharedSliceModel,
6
- } from "@prismicio/types";
6
+ } from "@prismicio/client";
7
7
 
8
8
  import { PathElement } from "../types";
9
+
9
10
  import { getHumanReadableModelName } from "./getHumanReadableModelName";
10
11
 
11
12
  type GetHumanReadableFieldPathConfig = {
@@ -1,5 +1,5 @@
1
- import type { CustomTypeModelField } from "@prismicio/types";
2
- import { CustomTypeModelLinkSelectType } from "@prismicio/types";
1
+ import type { CustomTypeModelField } from "@prismicio/client";
2
+ import { CustomTypeModelLinkSelectType } from "@prismicio/client";
3
3
 
4
4
  type GetFieldHumanReadableTypeConfig = {
5
5
  model: CustomTypeModelField;
@@ -3,7 +3,7 @@ import type {
3
3
  CustomTypeModelField,
4
4
  CustomTypeModelSlice,
5
5
  SharedSliceModel,
6
- } from "@prismicio/types";
6
+ } from "@prismicio/client";
7
7
 
8
8
  import { isCustomTypeModel } from "./isCustomTypeModel";
9
9
  import { isCustomTypeModelField } from "./isCustomTypeModelField";
@@ -1,6 +1,6 @@
1
1
  import * as tsm from "ts-morph";
2
- // import prettier from "prettier";
3
2
 
3
+ // import prettier from "prettier";
4
4
  import { BLANK_LINE_IDENTIFIER } from "../constants";
5
5
 
6
6
  export const getSourceFileText = (sourceFile: tsm.SourceFile): string => {
@@ -1,4 +1,4 @@
1
- import type { CustomTypeModel } from "@prismicio/types";
1
+ import type { CustomTypeModel } from "@prismicio/client";
2
2
 
3
3
  export const isCustomTypeModel = (model: unknown): model is CustomTypeModel => {
4
4
  return typeof model === "object" && model !== null && "json" in model;
@@ -1,4 +1,4 @@
1
- import type { CustomTypeModelField } from "@prismicio/types";
1
+ import type { CustomTypeModelField } from "@prismicio/client";
2
2
 
3
3
  export const isCustomTypeModelField = (
4
4
  model: unknown,
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  CustomTypeModelSlice,
3
3
  CustomTypeModelSliceType,
4
- } from "@prismicio/types";
4
+ } from "@prismicio/client";
5
5
 
6
6
  import { hasOwnProperty } from "./hasOwnProperty";
7
7
 
@@ -1,4 +1,4 @@
1
- import { CustomTypeModelSliceType, SharedSliceModel } from "@prismicio/types";
1
+ import { CustomTypeModelSliceType, SharedSliceModel } from "@prismicio/client";
2
2
 
3
3
  import { hasOwnProperty } from "./hasOwnProperty";
4
4
 
package/src/types.ts CHANGED
@@ -3,7 +3,7 @@ import type {
3
3
  CustomTypeModelField,
4
4
  CustomTypeModelSlice,
5
5
  SharedSliceModel,
6
- } from "@prismicio/types";
6
+ } from "@prismicio/client";
7
7
 
8
8
  export type PathElement<
9
9
  Model extends