fix: modify response types to intersection #445

devjiwonchoi · 2023-08-18T15:39:11Z

Description

Since Response types are currently in a union, the users cannot access response objects' property directly.

Example:

const response = await notion.blocks.children.list({
  block_id: block_id,
})

const archives = response.results.filter((block) => block.archived) // Error here

Property 'archived' does not exist on type 'PartialBlockObjectResponse | BlockObjectResponse'.
Property 'archived' does not exist on type 'PartialBlockObjectResponse'.ts(2339)

Fix

Current:

notion-sdk-js/src/api-endpoints.ts

Lines 10279 to 10286 in 83ac043

    
           export type ListBlockChildrenResponse = { 
        
             type: "block" 
        
             block: EmptyObject 
        
             object: "list" 
        
             next_cursor: string | null 
        
             has_more: boolean 
        
             results: Array<PartialBlockObjectResponse | BlockObjectResponse> 
        
           }

Fix:

// api-endpoints.ts
export type ListBlockChildrenResponse = {
    type: "block";
    block: EmptyObject;
    object: "list";
    next_cursor: string | null;
    has_more: boolean;
    results: Array<PartialBlockObjectResponse & BlockObjectResponse>; // union to intersection
};

Fixes #425 (comment) #443

Updating package name

v0.1.1

exports loglevel

v0.1.2

…path fix path

fixes missing error code

v0.1.3

this emits a warning from ava@typescipt which can be safely ignored

This reverts commit 1528de7.

This adds a warning in npm install for ava@typescript that can be safely ignored

lower node engine to >=12

Co-authored-by: Ryan Hart <ryan@makenotion.com>

Error Handling example uses `notion` variable without instantiating it first. Co-authored-by: Julie <julie@makenotion.com> Co-authored-by: Ryan Hart <ryan@makenotion.com>

Co-authored-by: Ryan Hart <ryan@makenotion.com>

…makenotion#394) * add instruction for giving integration access to database * update notion-github-sync with integration access instructions

…akenotion#411)

…n#401)

* add block text example * clean up comments * add embed option * update comment: * pr feeedback: name change, updated switch case, join richtext array without comma * use iteratePaginatedAPI helper to capture all blocks on page

* Wiki related changes * Remove oauth related endpoints

…with toggleable heading type (makenotion#438)

* add fullstack webform example app * update package.json detail * make linter happy * delete old folder (name change * Update examples/web-form-with-express/public/client.js Co-authored-by: Ron Yehoshua <ron@makenotion.com> * update var naming for improved readbility * add console back to match appendApiResponse() --------- Co-authored-by: Ron Yehoshua <ron@makenotion.com>

CLAassistant · 2023-08-18T15:39:16Z

All committers have signed the CLA.

rhart92 · 2023-10-03T00:10:57Z

Unfortunately we had to remove an old .env file from the repo which required completely re-writing the commit history causing this PR's commit history to be out of date. Please re-submit this PR after pulling a fresh copy of this repo 🙏 Apologies for any inconvenience.

aoberoi and others added 30 commits May 13, 2021 02:27

Updating package name

f4b17d4

Merge pull request makenotion#21 from makenotion/project-naming

e9d9d1f

Updating package name

allows methods to be called with no parameters

65f9ce8

add a description

8aa9e2e

Merge pull request makenotion#24 from makenotion/fix-empty-parameters

94a02ab

v0.1.1

5243d2a

Merge pull request makenotion#25 from makenotion/rel-0.1.1

19adf48

v0.1.1

exports loglevel

26d71f9

Merge pull request makenotion#27 from makenotion/fix-export-loglevel

30fd6d8

exports loglevel

v0.1.2

6f4867f

Merge pull request makenotion#28 from makenotion/rel-0.1.2

4538a0e

v0.1.2

fix path

4043564

Merge pull request makenotion#30 from makenotion/fix-databases-query-…

49489ca

…path fix path

fixes missing error code

4d78f9a

Merge pull request makenotion#32 from makenotion/fix-missing-error-code

f521bb1

fixes missing error code

v0.1.3

340361c

Merge pull request makenotion#33 from makenotion/rel-0.1.3

ccb2180

v0.1.3

fixes makenotion#58: block types

864969b

undo unintended formatting

fde58f7

fix: HeadingThreeBlock type

c08a8f8

lower node engine to >=12

1528de7

this emits a warning from ava@typescipt which can be safely ignored

Revert "lower node engine to >=12"

d4eb570

This reverts commit 1528de7.

lower node engine to >=12

1c94906

This adds a warning in npm install for ava@typescript that can be safely ignored

Merge pull request makenotion#79 from makenotion/node-to-12

9114629

lower node engine to >=12

update minimum supported node version in README

6d0326c

Merge branch 'main' of github.com:makenotion/notion-sdk-js into main

45cfeed

install and configure prettier

a63d29b

dont use tabs

b33c4ab

pretty as part of lint

07eec75

run prettier in scripts

f979e82

LitoMore and others added 26 commits March 7, 2023 16:02

Ingore VS Code settings (makenotion#364)

f25b391

Co-authored-by: Ryan Hart <ryan@makenotion.com>

Declare notion variable in README example (makenotion#291)

2aa9e04

Error Handling example uses `notion` variable without instantiating it first. Co-authored-by: Julie <julie@makenotion.com> Co-authored-by: Ryan Hart <ryan@makenotion.com>

Update example (makenotion#351)

49eadd7

Co-authored-by: Ryan Hart <ryan@makenotion.com>

Update example README instructions to include integration access note (…

13e0fad

…makenotion#394) * add instruction for giving integration access to database * update notion-github-sync with integration access instructions

Add support for creating template mentions (makenotion#396)

e836618

2.2.4 (makenotion#397)

9d139dc

Update examples with new SDK version. (makenotion#398)

ab29303

Decode to encode (makenotion#402)

0a385a0

Add peruvian_sol (makenotion#403)

e93ac5a

Upgrade to 2.2.5 (makenotion#404)

02ad37d

Add support for unique ID, public URL, and appending after a block (m…

e80a2df

…akenotion#411)

2.2.6 (makenotion#412)

1ae1d3f

Add helper for filtering search results to full objects (makenotion#413)

550c51c

2.2.7 (makenotion#421)

933f85b

Remove /// <reference lib="dom" /> from fetch-types.ts (makenotio…

e340426

…n#401)

2.2.8 (makenotion#423)

e48368a

Add example to parse any block text (makenotion#416)

15f21c5

* add block text example * clean up comments * add embed option * update comment: * pr feeedback: name change, updated switch case, join richtext array without comma * use iteratePaginatedAPI helper to capture all blocks on page

Endpoint changes for wikis (makenotion#428)

1d97c18

* Wiki related changes * Remove oauth related endpoints

Update to 2.2.9 (makenotion#429)

5634f28

Export isFullPageOrDatabase. (makenotion#434)

a041776

2.2.10 (makenotion#435)

fdf291a

Support oauth token endpoint, add wiki verification support, fix bug …

bcff1ef

…with toggleable heading type (makenotion#438)

Update rollup types (makenotion#439)

f2845b3

2.2.11 (makenotion#440)

83ac043

fix: modify response types to intersection

e0d063e

rhart92 force-pushed the main branch from 3bf8bfc to 241fcf1 Compare October 3, 2023 00:00

rhart92 closed this Oct 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: modify response types to intersection #445

fix: modify response types to intersection #445

devjiwonchoi commented Aug 18, 2023 •

edited

CLAassistant commented Aug 18, 2023 •

edited

rhart92 commented Oct 3, 2023

	export type ListBlockChildrenResponse = {
	type: "block"
	block: EmptyObject
	object: "list"
	next_cursor: string \| null
	has_more: boolean
	results: Array<PartialBlockObjectResponse \| BlockObjectResponse>
	}

fix: modify response types to intersection #445

fix: modify response types to intersection #445

Conversation

devjiwonchoi commented Aug 18, 2023 • edited

Description

Fix

CLAassistant commented Aug 18, 2023 • edited

rhart92 commented Oct 3, 2023

devjiwonchoi commented Aug 18, 2023 •

edited

CLAassistant commented Aug 18, 2023 •

edited