@prismicio/types - npm Package Compare versions

Comparing version 0.2.7 to 0.2.8

dist/api/query.d.ts

@@ -0,0 +0,0 @@ import { PrismicDocument } from "../value/document";

dist/api/ref.d.ts

@@ -0,0 +0,0 @@ /**

dist/api/release.d.ts

@@ -0,0 +0,0 @@ import { Ref } from "./ref";

dist/api/repository.d.ts

@@ -0,0 +0,0 @@ import { Ref } from "./ref";

dist/api/tags.d.ts

@@ -0,0 +0,0 @@ /**

dist/graphql/fields.d.ts

@@ -0,0 +0,0 @@ export declare const LinkType: {

dist/graphql/index.d.ts

 export { LinkType } from "./fields";
 export type { EmptyLinkField, FilledMinimalLinkToDocumentField, FilledMinimalLinkToWebField, FilledMinimalLinkToMediaField, RelationField, LinkField, LinkToMediaField, } from "./fields";

dist/index.d.ts

@@ -0,1 +1,3 @@
+import type { CustomTypeModelIntegrationField } from "./model/integration";
+import type { IntegrationField } from "./value/integration";
 export { RichTextNodeType } from "./value/richText";
@@ -20,3 +22,7 @@ export { LinkType } from "./value/link";
 export type { GeoPointField } from "./value/geoPoint";
-export type { IntegrationFields } from "./value/integrationFields";
+/**
+ * @deprecated Renamed to `IntegrationField`
+ */
+type IntegrationFields = IntegrationField;
+export { IntegrationField, IntegrationFields };
 export type { GroupField } from "./value/group";
@@ -48,3 +54,7 @@ export type { SliceZone } from "./value/sliceZone";
 export type { CustomTypeModelGeoPointField } from "./model/geoPoint";
-export type { CustomTypeModelIntegrationFieldsField } from "./model/integrationFields";
+/**
+ * @deprecated Renamed to `CustomTypeModelIntegrationField`.
+ */
+type CustomTypeModelIntegrationFieldsField = CustomTypeModelIntegrationField;
+export { CustomTypeModelIntegrationField, CustomTypeModelIntegrationFieldsField, };
 export type { CustomTypeModelGroupField } from "./model/group";
@@ -51,0 +61,0 @@ export type { CustomTypeModelSliceZoneField, CustomTypeModelSliceLabel, CustomTypeModelSharedSlice, } from "./model/sliceZone";

dist/model/boolean.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/color.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/contentRelationship.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/customType.d.ts

@@ -0,0 +0,0 @@ import { CustomTypeModelField } from "./types";

dist/model/date.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/embed.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/geoPoint.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/group.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType, CustomTypeModelFieldForGroup } from "./types";

dist/model/image.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/keyText.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/link.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/linkToMedia.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/number.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/range.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/richText.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/select.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/separator.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/sharedSlice.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelSliceType } from "./sliceZone";

dist/model/sharedSliceVariation.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldForGroup } from "./types";

dist/model/slice.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelGroupField } from "./group";

dist/model/sliceZone.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/timestamp.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/model/title.d.ts

@@ -0,0 +0,0 @@ import { CustomTypeModelRichTextSingleField } from "./richText";

dist/model/types.d.ts

@@ -16,3 +16,3 @@ import type { CustomTypeModelContentRelationshipField } from "./contentRelationship";
 import type { CustomTypeModelGeoPointField } from "./geoPoint";
-import type { CustomTypeModelIntegrationFieldsField } from "./integrationFields";
+import type { CustomTypeModelIntegrationField } from "./integration";
 import type { CustomTypeModelGroupField } from "./group";
@@ -34,3 +34,3 @@ import type { CustomTypeModelSliceZoneField } from "./sliceZone";
     readonly Image: "Image";
-    readonly IntegrationFields: "IntegrationFields";
+    readonly Integration: "IntegrationFields";
     readonly Link: "Link";
@@ -45,2 +45,6 @@ readonly Number: "Number";
     /**
+     * @deprecated - Renamed to `Integration`.
+     */
+    readonly IntegrationFields: "IntegrationFields";
+    /**
      * @deprecated - Legacy field type. Use `Number` instead.
@@ -65,2 +69,2 @@ */
  */
-export type CustomTypeModelFieldForGroup = CustomTypeModelBooleanField | CustomTypeModelColorField | CustomTypeModelDateField | CustomTypeModelEmbedField | CustomTypeModelGeoPointField | CustomTypeModelImageField | CustomTypeModelIntegrationFieldsField | CustomTypeModelContentRelationshipField | CustomTypeModelLinkField | CustomTypeModelLinkToMediaField | CustomTypeModelNumberField | CustomTypeModelRangeField | CustomTypeModelSelectField | CustomTypeModelRichTextField | CustomTypeModelTitleField | CustomTypeModelKeyTextField | CustomTypeModelTimestampField | CustomTypeModelSeparatorField;
+export type CustomTypeModelFieldForGroup = CustomTypeModelBooleanField | CustomTypeModelColorField | CustomTypeModelDateField | CustomTypeModelEmbedField | CustomTypeModelGeoPointField | CustomTypeModelImageField | CustomTypeModelIntegrationField | CustomTypeModelContentRelationshipField | CustomTypeModelLinkField | CustomTypeModelLinkToMediaField | CustomTypeModelNumberField | CustomTypeModelRangeField | CustomTypeModelSelectField | CustomTypeModelRichTextField | CustomTypeModelTitleField | CustomTypeModelKeyTextField | CustomTypeModelTimestampField | CustomTypeModelSeparatorField;

dist/model/types.js

@@ -9,3 +9,3 @@ const CustomTypeModelFieldType = {
   Image: "Image",
-  IntegrationFields: "IntegrationFields",
+  Integration: "IntegrationFields",
   Link: "Link",
@@ -19,2 +19,3 @@ Number: "Number",
   UID: "UID",
+  IntegrationFields: "IntegrationFields",
   Range: "Range",
@@ -21,0 +22,0 @@ Separator: "Separator",

dist/model/uid.d.ts

@@ -0,0 +0,0 @@ import type { CustomTypeModelFieldType } from "./types";

dist/value/boolean.d.ts

@@ -0,0 +0,0 @@ /**

dist/value/color.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/contentRelationship.d.ts

@@ -0,0 +0,0 @@ import type { AnyRegularField, FieldState } from "./types";

dist/value/date.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/document.d.ts

@@ -0,0 +0,0 @@ import { AnyRegularField } from "./types";

dist/value/embed.d.ts

@@ -0,0 +0,0 @@ import type { EmptyObjectField, FieldState } from "./types";

dist/value/geoPoint.d.ts

@@ -0,0 +0,0 @@ import type { EmptyObjectField, FieldState } from "./types";

dist/value/group.d.ts

@@ -0,0 +0,0 @@ import type { FieldState, AnyRegularField } from "./types";

dist/value/image.d.ts

@@ -0,0 +0,0 @@ import type { FieldState, Simplify } from "./types";

dist/value/keyText.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/link.d.ts

@@ -0,0 +0,0 @@ import type { FieldState, AnyRegularField } from "./types";

dist/value/linkToMedia.d.ts

@@ -0,0 +0,0 @@ import type { EmptyLinkField, LinkType } from "./link";

dist/value/number.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/richText.d.ts

@@ -0,0 +0,0 @@ import type { EmbedField } from "./embed";

dist/value/select.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/sharedSlice.d.ts

@@ -0,0 +0,0 @@ import type { SharedSliceVariation } from "./sharedSliceVariation";

dist/value/sharedSliceVariation.d.ts

@@ -0,0 +0,0 @@ import type { AnyRegularField } from "./types";

dist/value/slice.d.ts

@@ -0,0 +0,0 @@ import type { AnyRegularField } from "./types";

dist/value/sliceZone.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/timestamp.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/title.d.ts

@@ -0,0 +0,0 @@ import type { FieldState } from "./types";

dist/value/types.d.ts

@@ -16,3 +16,3 @@ import type { RichTextField } from "./richText";
 import type { GeoPointField } from "./geoPoint";
-import type { IntegrationFields } from "./integrationFields";
+import type { IntegrationField } from "./integration";
 /**
@@ -29,3 +29,3 @@ * Empty state for object-shaped fields.
  */
-export type AnyRegularField = TitleField | RichTextField | ImageField | ContentRelationshipField | LinkField | LinkToMediaField | EmbedField | DateField | TimestampField | ColorField | NumberField | KeyTextField | SelectField | BooleanField | GeoPointField | IntegrationFields;
+export type AnyRegularField = TitleField | RichTextField | ImageField | ContentRelationshipField | LinkField | LinkToMediaField | EmbedField | DateField | TimestampField | ColorField | NumberField | KeyTextField | SelectField | BooleanField | GeoPointField | IntegrationField;
 /**
@@ -32,0 +32,0 @@ * Useful to flatten the type output to improve type hints shown in editors. And

dist/webhook/apiUpdate.d.ts

@@ -0,0 +0,0 @@ import { WebhookBodyBase, WebhookType } from "./types";

dist/webhook/testTrigger.d.ts

@@ -0,0 +0,0 @@ import { WebhookBodyBase, WebhookType } from "./types";

dist/webhook/types.d.ts

@@ -0,0 +0,0 @@ import { WebhookBodyAPIUpdate } from "./apiUpdate";

package.json

 {
 	"name": "@prismicio/types",
-	"version": "0.2.7",
+	"version": "0.2.8",
 	"description": "Type definitions for Prismic related structure",
@@ -5,0 +5,0 @@ "keywords": [

src/index.ts

 // NOTE: The GraphQL exports are purposely not included in the root-level API.
 // Instead, they are provided under their own `/graphql` entry.
 
+// Imports are used for deprecations.
+import type { CustomTypeModelIntegrationField } from "./model/integration";
+import type { IntegrationField } from "./value/integration";
+
 //=============================================================================
@@ -102,3 +106,8 @@ // Value - Types representing Prismic document and field values.
 
-export type { IntegrationFields } from "./value/integrationFields";
+/**
+ * @deprecated Renamed to `IntegrationField`
+ */
+// TODO: Remove when we remove support for deprecated `IntegrationFields` export.
+type IntegrationFields = IntegrationField;
+export { IntegrationField, IntegrationFields };
 
@@ -157,3 +166,11 @@ export type { GroupField } from "./value/group";
 
-export type { CustomTypeModelIntegrationFieldsField } from "./model/integrationFields";
+/**
+ * @deprecated Renamed to `CustomTypeModelIntegrationField`.
+ */
+// TODO: Remove when we remove support for deprecated `CustomTypeModelIntegrationField` export.
+type CustomTypeModelIntegrationFieldsField = CustomTypeModelIntegrationField;
+export {
+	CustomTypeModelIntegrationField,
+	CustomTypeModelIntegrationFieldsField,
+};
 export type { CustomTypeModelGroupField } from "./model/group";
@@ -160,0 +177,0 @@ export type {

src/model/types.ts

@@ -18,3 +18,3 @@ import type { CustomTypeModelContentRelationshipField } from "./contentRelationship";
 
-import type { CustomTypeModelIntegrationFieldsField } from "./integrationFields";
+import type { CustomTypeModelIntegrationField } from "./integration";
 import type { CustomTypeModelGroupField } from "./group";
@@ -39,3 +39,3 @@ import type { CustomTypeModelSliceZoneField } from "./sliceZone";
 	Image: "Image",
-	IntegrationFields: "IntegrationFields",
+	Integration: "IntegrationFields",
 	Link: "Link",
@@ -50,2 +50,6 @@ Number: "Number",
 	/**
+	 * @deprecated - Renamed to `Integration`.
+	 */
+	IntegrationFields: "IntegrationFields",
+	/**
 	 * @deprecated - Legacy field type. Use `Number` instead.
@@ -83,3 +87,3 @@ */
 	| CustomTypeModelImageField
-	| CustomTypeModelIntegrationFieldsField
+	| CustomTypeModelIntegrationField
 	| CustomTypeModelContentRelationshipField
@@ -86,0 +90,0 @@ | CustomTypeModelLinkField

src/value/types.ts

@@ -18,3 +18,3 @@ import type { RichTextField } from "./richText";
 
-import type { IntegrationFields } from "./integrationFields";
+import type { IntegrationField } from "./integration";
 
@@ -50,3 +50,3 @@ /**
 	| GeoPointField
-	| IntegrationFields;
+	| IntegrationField;
 
@@ -53,0 +53,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

4172

increased by0.87%

Worsened metrics

Total package byte prevSize

196311

decreased by-0.2%

No dependency changes