refactor: use @prismicio/types where possible

prismicio · May 22, 2021 · bb2b514 · bb2b514
1 parent ec26d6a
commit bb2b514
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 52 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,6 +16,7 @@
   },
   "license": "Apache-2.0",
   "author": "Prismic <contact@prismic.io> (https://prismic.io)",
+  "type": "module",
   "exports": {
     ".": {
       "require": "./dist/index.js",
@@ -61,6 +62,7 @@
   "devDependencies": {
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
+    "@prismicio/types": "^0.0.6",
     "@types/node-fetch": "^2.5.10",
     "@types/sinon": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^4.24.0",

diff --git a/src/buildQueryURL.ts b/src/buildQueryURL.ts
@@ -2,6 +2,8 @@ import { ValueOf } from 'type-fest'
 
 import { castArray } from './lib/castArray'
 
+import { Ordering } from './types'
+
 /**
  * Parameters for the Prismic REST API V2.
  *
@@ -91,16 +93,6 @@ type BuildQueryURLParams = {
   predicates?: string | string[]
 }
 
-/**
- * An `orderings` parameter that orders the results by the specified field.
- *
- * {@link https://prismic.io/docs/technologies/search-parameters-reference-rest-api#orderings}
- */
-type Ordering = {
-  field: string
-  direction?: 'asc' | 'desc'
-}
-
 /**
  * Parameters in this map have been renamed from the official Prismic REST API
  * V2 specification for better developer ergonomics.

diff --git a/src/client.ts b/src/client.ts
@@ -1,8 +1,9 @@
+import * as prismicT from '@prismicio/types'
+
 import { appendPredicates } from './lib/appendPredicates'
 import { getCookie } from './lib/getCookie'
 
 import {
-  Document,
   FetchLike,
   HttpRequestLike,
   LinkResolver,
@@ -277,7 +278,7 @@ export class Client {
    * const response = await client.get()
    * ```
    */
-  async get<TDocument extends Document>(
+  async get<TDocument extends prismicT.PrismicDocument>(
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<Query<TDocument>> {
     const url = await this.buildQueryURL(params)
@@ -298,7 +299,7 @@ export class Client {
    * const document = await client.getFirst()
    * ```
    */
-  async getFirst<TDocument extends Document>(
+  async getFirst<TDocument extends prismicT.PrismicDocument>(
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<TDocument> {
     const result = await this.get<TDocument>(params)
@@ -326,7 +327,7 @@ export class Client {
    * const response = await client.getAll()
    * ```
    */
-  async getAll<TDocument extends Document>(
+  async getAll<TDocument extends prismicT.PrismicDocument>(
     params: Partial<Omit<BuildQueryURLArgs, 'page'>> & GetAllParams = {},
   ): Promise<TDocument[]> {
     const { limit = Infinity, ...actualParams } = params
@@ -364,7 +365,7 @@ export class Client {
    * const document = await client.getByID('WW4bKScAAMAqmluX')
    * ```
    */
-  async getByID<TDocument extends Document>(
+  async getByID<TDocument extends prismicT.PrismicDocument>(
     id: string,
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<TDocument> {
@@ -391,7 +392,7 @@ export class Client {
    * const response = await client.getByIDs(['WW4bKScAAMAqmluX', 'U1kTRgEAAC8A5ldS'])
    * ```
    */
-  async getByIDs<TDocument extends Document>(
+  async getByIDs<TDocument extends prismicT.PrismicDocument>(
     ids: string[],
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<Query<TDocument>> {
@@ -420,7 +421,7 @@ export class Client {
    * const response = await client.getAllByIDs(['WW4bKScAAMAqmluX', 'U1kTRgEAAC8A5ldS'])
    * ```
    */
-  async getAllByIDs<TDocument extends Document>(
+  async getAllByIDs<TDocument extends prismicT.PrismicDocument>(
     ids: string[],
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<TDocument[]> {
@@ -448,7 +449,7 @@ export class Client {
    * const document = await client.getByUID('blog_post', 'my-first-post')
    * ```
    */
-  async getByUID<TDocument extends Document>(
+  async getByUID<TDocument extends prismicT.PrismicDocument>(
     documentType: string,
     uid: string,
     params?: Partial<BuildQueryURLArgs>,
@@ -479,7 +480,7 @@ export class Client {
    * const document = await client.getSingle('settings')
    * ```
    */
-  async getSingle<TDocument extends Document>(
+  async getSingle<TDocument extends prismicT.PrismicDocument>(
     documentType: string,
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<TDocument> {
@@ -504,7 +505,7 @@ export class Client {
    * const response = await client.getByType('blog_post')
    * ```
    */
-  async getByType<TDocument extends Document>(
+  async getByType<TDocument extends prismicT.PrismicDocument>(
     documentType: string,
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<Query<TDocument>> {
@@ -529,7 +530,7 @@ export class Client {
    * const response = await client.getByType('blog_post')
    * ```
    */
-  async getAllByType<TDocument extends Document>(
+  async getAllByType<TDocument extends prismicT.PrismicDocument>(
     documentType: string,
     params?: Partial<Omit<BuildQueryURLArgs, 'page'>>,
   ): Promise<TDocument[]> {
@@ -554,7 +555,7 @@ export class Client {
    * const response = await client.getByTag('food')
    * ```
    */
-  async getByTag<TDocument extends Document>(
+  async getByTag<TDocument extends prismicT.PrismicDocument>(
     tag: string,
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<Query<TDocument>> {
@@ -579,7 +580,7 @@ export class Client {
    * const response = await client.getAllByTag('food')
    * ```
    */
-  async getAllByTag<TDocument extends Document>(
+  async getAllByTag<TDocument extends prismicT.PrismicDocument>(
     tag: string,
     params?: Partial<Omit<BuildQueryURLArgs, 'page'>>,
   ): Promise<TDocument[]> {
@@ -602,7 +603,7 @@ export class Client {
    * const response = await client.getAllByTag('food')
    * ```
    */
-  async getByTags<TDocument extends Document>(
+  async getByTags<TDocument extends prismicT.PrismicDocument>(
     tags: string[],
     params?: Partial<BuildQueryURLArgs>,
   ): Promise<Query<TDocument>> {
@@ -627,7 +628,7 @@ export class Client {
    * const response = await client.getAllByTag('food')
    * ```
    */
-  async getAllByTags<TDocument extends Document>(
+  async getAllByTags<TDocument extends prismicT.PrismicDocument>(
     tags: string[],
     params?: Partial<Omit<BuildQueryURLArgs, 'page'>>,
   ): Promise<TDocument[]> {

diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,4 @@
-// TODO: Migrate types to @prismicio/types and use that library throughout the package.
+import * as prismicT from '@prismicio/types'
 
 export interface Ref {
   ref: string
@@ -13,28 +13,6 @@ export interface Language {
   name: string
 }
 
-export interface Document<Data = Record<string, unknown>> {
-  id: string
-  uid?: string
-  url?: string
-  type: string
-  href: string
-  tags: string[]
-  slugs: string[]
-  lang?: string
-  alternate_languages: AlternateLanguage[]
-  first_publication_date: string | null
-  last_publication_date: string | null
-  data: Data
-}
-
-export interface AlternateLanguage {
-  id: string
-  uid?: string
-  type: string
-  lang: string
-}
-
 export interface Repository {
   refs: Ref[]
   bookmarks: Record<string, string>
@@ -52,7 +30,9 @@ export interface Repository {
   license: string
 }
 
-export interface Query<TDocument extends Document = Document> {
+export interface Query<
+  TDocument extends prismicT.PrismicDocument = prismicT.PrismicDocument,
+> {
   page: number
   results_per_page: number
   results_size: number
@@ -78,9 +58,9 @@ export interface FormField {
   default?: string
 }
 
-export type LinkResolver<TDocument extends Document = Document> = (
-  document: TDocument,
-) => string
+export type LinkResolver<
+  TDocument extends prismicT.PrismicDocument = prismicT.PrismicDocument,
+> = (document: TDocument) => string
 
 /**
  * A universal API to make network requests. A subset of the `fetch()` API.
@@ -115,3 +95,13 @@ export interface HttpRequestLike {
   }
   query?: Record<string, unknown>
 }
+
+/**
+ * An `orderings` parameter that orders the results by the specified field.
+ *
+ * {@link https://prismic.io/docs/technologies/search-parameters-reference-rest-api#orderings}
+ */
+export interface Ordering {
+  field: string
+  direction?: 'asc' | 'desc'
+}