fix: type PrismicDocument.*_publication_date as `TimestampField<"fi…

…lled">` (#304) * fix: type `PrismicDocument.*_publication_date` as `TimestampField<"filled">` * chore: remove self-referrential `@prismicio/client` dependency * refactor: remove `@ts-expect-error` comments
prismicio · Jun 3, 2023 · 7cce22a · 7cce22a
1 parent db85d21
commit 7cce22a
Show file tree

Hide file tree

Showing 9 changed files with 197 additions and 193 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
  "imgix-url-builder": "^0.0.3"
  },
  "devDependencies": {
- "@prismicio/mock": "^0.2.0",
+ "@prismicio/mock": "^0.3.0",
  "@prismicio/types-internal": "2.0.0-alpha.11",
  "@size-limit/preset-small-lib": "^8.2.4",
  "@trivago/prettier-plugin-sort-imports": "^4.1.1",

diff --git a/src/types/value/document.ts b/src/types/value/document.ts
@@ -2,6 +2,7 @@ import { AnyRegularField } from "./types";
 
 import { GroupField } from "./group";
 import { SliceZone } from "./sliceZone";
+import { TimestampField } from "./timestamp";
 
 /**
  * Document metadata for a translation of a Prismic document.
@@ -46,11 +47,11 @@ export interface PrismicDocumentHeader<TypeEnum = string, LangEnum = string> {
  /**
  * The timestamp at which the document was first published.
  */
- first_publication_date: string;
+ first_publication_date: TimestampField<"filled">;
  /**
  * The timestamp at which the document was last published.
  */
- last_publication_date: string;
+ last_publication_date: TimestampField<"filled">;
  /**
  * Slugs associated with document.
  *

diff --git a/test/helpers-asDate.test.ts b/test/helpers-asDate.test.ts
@@ -1,5 +1,7 @@
 import { expect, it } from "vitest";
 
+import { documentFixture } from "./__fixtures__/document";
+
 import { asDate } from "../src";
 
 it("returns null for nullish inputs", () => {
@@ -30,3 +32,16 @@ it("returns a date object from a timestamp field", () => {
 
  expect(asDate(field)).toBeInstanceOf(Date);
 });
+
+it("is compatible with a document's first_publication_date and last_publication_date properties", () => {
+ // This test is functionally no different than the tests above, but we
+ // can at least check that the types between `PrismicDocument` and
+ // `asDate()` are compatible.
+
+ expect(asDate(documentFixture.empty.first_publication_date)).toBeInstanceOf(
+ Date,
+ );
+ expect(asDate(documentFixture.empty.last_publication_date)).toBeInstanceOf(
+ Date,
+ );
+});
diff --git a/test/helpers-isFilled.test.ts b/test/helpers-isFilled.test.ts
@@ -1,5 +1,7 @@
 import { expect, it } from "vitest";
 
+import { documentFixture } from "./__fixtures__/document";
+
 import { GroupField, SliceZone, isFilled } from "../src";
 
 it("color", (ctx) => {
@@ -78,12 +80,10 @@ it("image thumbnail", () => {
 it("integration fields", (ctx) => {
  expect(isFilled.integrationField(null)).toBe(false);
  expect(isFilled.integrationField(undefined)).toBe(false);
- expect(isFilled.integrationField(ctx.mock.value.integrationFields())).toBe(
- true,
- );
+ expect(isFilled.integrationField(ctx.mock.value.integration())).toBe(true);
 });
 it("aliases integrationFields to integrationField", () => {
- expect(isFilled.integrationFields).toBe(isFilled.integrationField);
+ expect(isFilled.integrationField).toBe(isFilled.integrationField);
 });
 
 it("key text", (ctx) => {
@@ -163,6 +163,12 @@ it("timestamp", (ctx) => {
  expect(isFilled.timestamp(null)).toBe(false);
  expect(isFilled.timestamp(undefined)).toBe(false);
  expect(isFilled.timestamp(ctx.mock.value.timestamp())).toBe(true);
+ expect(isFilled.timestamp(documentFixture.empty.first_publication_date)).toBe(
+ true,
+ );
+ expect(isFilled.timestamp(documentFixture.empty.last_publication_date)).toBe(
+ true,
+ );
 });
 
 it("title", (ctx) => {

diff --git a/test/types/api-query.types.ts b/test/types/api-query.types.ts
@@ -34,8 +34,8 @@ expectType<prismic.Query>({
  type: "string",
  href: "string",
  tags: ["string"],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: ["string"],
  linked_documents: [],
  lang: "string",
@@ -91,8 +91,8 @@ expectType<
  type: "string",
  href: "string",
  tags: ["string"],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: ["string"],
  linked_documents: [],
  lang: "string",

diff --git a/test/types/document-prismicDocument.types.ts b/test/types/document-prismicDocument.types.ts
@@ -25,8 +25,8 @@ expectType<prismic.PrismicDocument>({
  type: "string",
  href: "string",
  tags: ["string"],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: ["string"],
  linked_documents: [],
  lang: "string",
@@ -51,8 +51,8 @@ expectType<prismic.PrismicDocument>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -70,8 +70,8 @@ expectType<prismic.PrismicDocument<{ foo: prismic.BooleanField }>>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -98,8 +98,8 @@ expectType<
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -120,8 +120,8 @@ expectType<prismic.PrismicDocument<Record<string, never>, "foo">>({
  type: "foo",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -136,8 +136,8 @@ expectType<prismic.PrismicDocument<Record<string, never>, "foo">>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -155,8 +155,8 @@ expectType<prismic.PrismicDocument<Record<string, never>, string, "fr-fr">>({
  type: "foo",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  lang: "fr-fr",
@@ -170,8 +170,8 @@ expectType<prismic.PrismicDocument<Record<string, string>, string, "fr-fr">>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2020-06-29T15:13:27+0000",
  slugs: [],
  linked_documents: [],
  // @ts-expect-error - Document lang must match the given language.

diff --git a/test/types/document-prismicDocumentWithUID.types.ts b/test/types/document-prismicDocumentWithUID.types.ts
@@ -25,8 +25,8 @@ expectType<prismic.PrismicDocumentWithUID>({
  type: "string",
  href: "string",
  tags: ["string"],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: ["string"],
  linked_documents: [],
  lang: "string",
@@ -52,8 +52,8 @@ expectType<prismic.PrismicDocumentWithUID>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -71,8 +71,8 @@ expectType<prismic.PrismicDocumentWithUID>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -90,8 +90,8 @@ expectType<prismic.PrismicDocumentWithUID<{ foo: prismic.BooleanField }>>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -118,8 +118,8 @@ expectType<
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -140,8 +140,8 @@ expectType<prismic.PrismicDocumentWithUID<Record<string, never>, "foo">>({
  type: "foo",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -156,8 +156,8 @@ expectType<prismic.PrismicDocumentWithUID<Record<string, never>, "foo">>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -177,8 +177,8 @@ expectType<
  type: "foo",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "fr-fr",
@@ -194,8 +194,8 @@ expectType<
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  // @ts-expect-error - Document lang must match the given language.

diff --git a/test/types/document-prismicDocumentWithoutUID.types.ts b/test/types/document-prismicDocumentWithoutUID.types.ts
@@ -25,8 +25,8 @@ expectType<prismic.PrismicDocumentWithoutUID>({
  type: "string",
  href: "string",
  tags: ["string"],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: ["string"],
  linked_documents: [],
  lang: "string",
@@ -52,8 +52,8 @@ expectType<prismic.PrismicDocumentWithoutUID>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -71,8 +71,8 @@ expectType<prismic.PrismicDocumentWithoutUID>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -90,8 +90,8 @@ expectType<prismic.PrismicDocumentWithoutUID<{ foo: prismic.BooleanField }>>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -118,8 +118,8 @@ expectType<
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -140,8 +140,8 @@ expectType<prismic.PrismicDocumentWithoutUID<Record<string, never>, "foo">>({
  type: "foo",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -156,8 +156,8 @@ expectType<prismic.PrismicDocumentWithoutUID<Record<string, never>, "foo">>({
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "string",
@@ -177,8 +177,8 @@ expectType<
  type: "foo",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  lang: "fr-fr",
@@ -194,8 +194,8 @@ expectType<
  type: "string",
  href: "string",
  tags: [],
- first_publication_date: "string",
- last_publication_date: "string",
+ first_publication_date: "2020-06-29T15:13:27+0000",
+ last_publication_date: "2021-05-18T15:44:01+0000",
  slugs: [],
  linked_documents: [],
  // @ts-expect-error - Document lang must match the given language.