Merge pull request #13 from pubpub/fix/fixes

readme.md

@@ -3240,7 +3240,6 @@ You need to be **logged in** and have access to this resource.
   accentTextColor: string
   avatar: null | string
   citeAs: null | string
-  communityId: string
   defaultPubCollections: null | string[]
   description: null | string
   domain: null | string
@@ -3643,7 +3642,7 @@ You need to be **logged in** and have access to this resource.
     CitationStyle:
       | undefined
       | {
-          citationStyle:
+          citationStyle?:
             | 'acm-siggraph'
             | 'american-anthro'
             | 'apa'
@@ -3657,12 +3656,18 @@ You need to be **logged in** and have access to this resource.
             | 'mla'
             | 'vancouver'
             | 'ama'
-          inlineCitationStyle: 'label' | 'count' | 'authorYear' | 'author'
+            | undefined
+          inlineCitationStyle?:
+            | 'label'
+            | 'count'
+            | 'authorYear'
+            | 'author'
+            | undefined
         }
     License:
       | undefined
       | {
-          kind:
+          kind?:
             | 'cc-by'
             | 'cc-0'
             | 'cc-by-nc'
@@ -3671,30 +3676,53 @@ You need to be **logged in** and have access to this resource.
             | 'cc-by-nc-sa'
             | 'cc-by-sa'
             | 'copyright'
-          copyrightSelection: {
-            choice: 'infer-from-scope' | 'choose-here'
-            year: number | null
-          }
+            | undefined
+          copyrightSelection?:
+            | {
+                choice?: 'infer-from-scope' | 'choose-here' | undefined
+                year?: number | null | undefined
+              }
+            | undefined
         }
     NodeLabels:
       | undefined
       | {
-          image: { enabled: boolean; text: string }
-          video: { enabled: boolean; text: string }
-          audio: { enabled: boolean; text: string }
-          table: { enabled: boolean; text: string }
-          math: { enabled: boolean; text: string }
-          iframe: { enabled: boolean; text: string }
+          image?:
+            | { enabled?: boolean | undefined; text?: string | undefined }
+            | undefined
+          video?:
+            | { enabled?: boolean | undefined; text?: string | undefined }
+            | undefined
+          audio?:
+            | { enabled?: boolean | undefined; text?: string | undefined }
+            | undefined
+          table?:
+            | { enabled?: boolean | undefined; text?: string | undefined }
+            | undefined
+          math?:
+            | { enabled?: boolean | undefined; text?: string | undefined }
+            | undefined
+          iframe?:
+            | { enabled?: boolean | undefined; text?: string | undefined }
+            | undefined
         }
     PubEdgeDisplay:
       | undefined
-      | { defaultsToCarousel: boolean; descriptionIsVisible: boolean }
+      | {
+          defaultsToCarousel?: boolean | undefined
+          descriptionIsVisible?: boolean | undefined
+        }
     PubHeaderTheme:
       | undefined
       | {
-          backgroundImage: string
-          backgroundColor: string
-          textStyle: 'light' | 'dark' | 'black-blocks' | 'white-blocks'
+          backgroundImage?: string | undefined
+          backgroundColor?: string | undefined
+          textStyle?:
+            | 'light'
+            | 'dark'
+            | 'black-blocks'
+            | 'white-blocks'
+            | undefined
         }
   }
   scope: {
@@ -4603,67 +4631,25 @@ You need to be **logged in** and have access to this resource.
 `input?`
 
 ```ts
-
-  | {
-      avatar: null | string
-      collectionId: null | string
-      communityId: string
-      createPubToken: undefined
-      customPublishedAt: null | string
-      description: null | string
-      doi: null | string
-      downloads:
-        | null
-        | {
-            createdAt: string
-            type: 'formatted'
-            url: string
-          }[]
-      htmlDescription: null | string
-      htmlTitle: null | string
-      slug: string
-      title: string
-    }
-  | {
-      avatar: null | string
-      collectionId: undefined
-      communityId: string
-      createPubToken: null | string
-      customPublishedAt: null | string
-      description: null | string
-      doi: null | string
-      downloads:
-        | null
-        | {
-            createdAt: string
-            type: 'formatted'
-            url: string
-          }[]
-      htmlDescription: null | string
-      htmlTitle: null | string
-      slug: string
-      title: string
-    }
-  | {
-      avatar: null | string
-      collectionId: undefined
-      communityId: string
-      createPubToken: undefined
-      customPublishedAt: null | string
-      description: null | string
-      doi: null | string
-      downloads:
-        | null
-        | {
-            createdAt: string
-            type: 'formatted'
-            url: string
-          }[]
-      htmlDescription: null | string
-      htmlTitle: null | string
-      slug: string
-      title: string
-    }
+{
+  avatar: null | string
+  collectionId: null | string
+  createPubToken: null | string
+  customPublishedAt: null | string
+  description: null | string
+  doi: null | string
+  downloads:
+    | null
+    | {
+        createdAt: string
+        type: 'formatted'
+        url: string
+      }[]
+  htmlDescription: null | string
+  htmlTitle: null | string
+  slug: string
+  title: string
+}
 ```
 
 `rest?`
@@ -4763,8 +4749,7 @@ You need to be **logged in** and have access to this resource.
 `input`
 
 ```ts
-{
-}
+;undefined | null | {}
 ```
 
 `rest`
@@ -4839,8 +4824,7 @@ You need to be **logged in** and have access to this resource.
 `input`
 
 ```ts
-{
-}
+;undefined | null | {}
 ```
 
 `rest`

src/lib/client-types.ts

@@ -19,35 +19,44 @@ export type Prettify<T> = {
 export type ProxiedFunction<
   F,
   IsGetRoute extends boolean = false,
-  Property extends 'body' | 'query' = IsGetRoute extends false
+  BodyOrQuery extends 'body' | 'query' = IsGetRoute extends false
     ? 'body'
     : 'query',
-> = F extends (...args: infer A extends any[]) => infer R
-  ? A[0] extends { [K in Property]: infer B }
+> = F extends (...args: infer Arguments extends any[]) => infer R
+  ? Arguments[0] extends { [K in BodyOrQuery]: infer B }
     ? // if only the body is required, make the second argument optional
-      Partial<Omit<A[0], Property>> extends Omit<A[0], Property>
-      ? FormData extends B
+      Partial<Omit<Arguments[0], BodyOrQuery>> extends Omit<
+        Arguments[0],
+        BodyOrQuery
+      >
+      ? // form bodies look like FormData & {...}, we don't want to require the FormData part
+        FormData extends B
         ? (
             input: Exclude<B, FormData>,
-            rest?: Prettify<Omit<A[0], Property>>,
+            rest?: Prettify<Omit<Arguments[0], BodyOrQuery>>,
           ) => R
         : Partial<Omit<B, 'communityId'>> extends Omit<B, 'communityId'>
           ? // if there are no required arguments, you don't need to pass the body
             (
-              input?: Prettify<B>, //Prettify<Omit<B, 'communityId'>>,
-              rest?: Prettify<Omit<A[0], Property>>,
+              input?: Prettify<Omit<B, 'communityId'>>, //Prettify<Omit<B, 'communityId'>>,
+              rest?: Prettify<Omit<Arguments[0], BodyOrQuery>>,
             ) => R
           : (
               input: Prettify<Omit<B, 'communityId'>>,
-              rest?: Prettify<Omit<A[0], Property>>,
+              rest?: Prettify<Omit<Arguments[0], BodyOrQuery>>,
             ) => R
-      : (
-          input: Prettify<Omit<B, 'communityId'>>,
-          rest: Prettify<Omit<A[0], Property>>,
-        ) => R
-    : undefined extends A[0]
-      ? (input?: Prettify<A[0]>) => R
-      : (input: Prettify<A[0]>) => R
+      : FormData extends B
+        ? (
+            input: Exclude<B, FormData>,
+            rest: Prettify<Omit<Arguments[0], BodyOrQuery>>,
+          ) => R
+        : (
+            input: Prettify<Omit<B, 'communityId'>>,
+            rest: Prettify<Omit<Arguments[0], BodyOrQuery>>,
+          ) => R
+    : undefined extends Arguments[0]
+      ? (input?: Prettify<Arguments[0]>) => R
+      : (input: Prettify<Arguments[0]>) => R
   : never
 
 export type ProxiedClient<T> = {

test/test.test.ts

@@ -171,6 +171,7 @@ describe('PubPub', () => {
 
   // it('should be able to update a community', async () => {})
 
+  let importedPubId: string
   it('should be able to import a pub', async () => {
     const { body } = await pubpub.pub.text.import({
       files: [
@@ -190,6 +191,35 @@ describe('PubPub', () => {
     expect(JSON.stringify(doc)?.includes('heya')).toBeTruthy()
     expect(pub).toHaveProperty('title')
     expect(pub.title).toBe('imported pub')
+
+    importedPubId = pub.id
+  }, 20000)
+
+  it('should be able to import to a pub', async () => {
+    const { body } = await pubpub.pub.text.importToPub(
+      {
+        files: [
+          {
+            blob: new Blob([':D'], { type: 'text/plain' }),
+            filename: 'happy.txt',
+          },
+        ],
+        method: 'append',
+      },
+      {
+        params: {
+          pubId: importedPubId,
+        },
+      },
+    )
+
+    const { doc, pub } = body
+
+    expect(pub.id).toEqual(importedPubId)
+
+    const stringDoc = JSON.stringify(doc)
+    expect(stringDoc).toContain(':D')
+    expect(stringDoc).toContain('heya')
   }, 20000)
 
   it('should be able to query things', async () => {