Skip to content

Commit 9d79092

Browse files
uttamukkojiuttamukkoji
committed
Typesript definitions and test case added
1 parent ca4003a commit 9d79092

File tree

5 files changed

+87
-30
lines changed

5 files changed

+87
-30
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ test/smtpconfig.js/*
88
test/config.js/*
99
test/sync_config.js/*
1010
test/report.json/*
11-
tap-html.html
11+
tap-html.html
12+
*html-report

‎index.d.ts

Lines changed: 71 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ export class ContentType {
8585
constructor();
8686
content_type_uid: string
8787

88-
fetch(): Promise<any>;
8988
Query(): Query;
9089
Entry(uid: string): Entry;
90+
fetch(fetchOptions?: object): Promise<any>;
9191
}
9292

9393
export class Assets {
@@ -102,51 +102,102 @@ export class Assets {
102102
export class Asset {
103103
constructor();
104104

105+
asset_uid: string
106+
105107
toJSON(): Assets;
106108
addParam(key: string, value: any): Assets;
107-
fetch(): Promise<any>;
109+
fetch(fetchOptions?: object): Promise<any>;
108110
}
109111

110112
export class Entry {
111113
constructor();
112114

115+
entry_uid: string;
116+
content_type_uid: string;
117+
_query: object;
118+
provider: any;
119+
cachePolicy: number;
120+
queryCachePolicy: number;
121+
122+
only(field_uid: string): Entry;
123+
only(field_uids: string[]): Entry;
124+
only(reference_field_uid:string, field_uid: string): Entry;
125+
only(reference_field_uid:string, field_uids: string[]): Entry;
126+
127+
except(field_uid: string): Entry;
128+
except(field_uids: string[]): Entry;
129+
except(reference_field_uid:string, field_uid: string): Entry;
130+
except(reference_field_uid:string, field_uids: string[]): Entry;
131+
113132
setCacheProvider(provider: object): Entry;
114133
setCachePolicy(policy: number): Entry;
115134
includeReference(val: string[]): Entry;
116135
includeReference(...val: string[]): Entry;
117136
language(language_code: string): Entry;
118137
addQuery(key: string, value: string): Entry;
138+
139+
/**
140+
* @deprecated since verion 3.3.0
141+
*/
119142
includeSchema(): Entry;
120143
includeReferenceContentTypeUID(): Entry;
121144
includeContentType(): Entry;
122145
includeOwner(): Entry;
123146
toJSON(): Entry;
124147
addParam(key: string, value: any): Entry;
125-
fetch(): Promise<any>;
148+
fetch(fetchOptions?: object): Promise<any>;
126149
}
127150

128151
export class Query extends Entry {
129152
constructor();
153+
_query: object;
154+
155+
getQuery(): Query;
156+
157+
count(fetchOptions?: object): Query;
158+
includeCount(): Query;
159+
query(query: object): Query;
130160

131-
equalTo(key: string, value: any): Query;
132-
where(key: string, value: any): Query;
133-
count(): Query;
134-
query(query: any): Query;
135161
referenceIn(key: string, query: Query): Query;
136162
referenceNotIn(key: string, query: Query): Query;
137-
tags(value: any[]): Query;
138-
includeCount(): Query;
139-
getQuery(): Query;
140-
regex(key: string, value: any, options: string): Query;
163+
164+
tags(value: string[]): Query;
165+
166+
where(key: string, value: (string | number)): Query;
167+
equalTo(key: string, value: (string | number)): Query;
168+
notEqualTo(key: string, value: (string | number)): Query;
169+
170+
lessThan(key: string, value: (string | number)): Query;
171+
lessThanOrEqualTo(key: string, value: (string | number)): Query;
172+
173+
greaterThan(key: string, value: (string | number)): Query;
174+
greaterThanOrEqualTo(key: string, value: (string | number)): Query;
175+
176+
containedIn(key: string, value: (string | number)[]): Query;
177+
notContainedIn(key: string, value: (string | number)[]): Query;
178+
179+
exists(key: string): Query;
180+
notExists(key: string): Query;
181+
182+
ascending(key: string): Query;
183+
descending(key: string): Query;
184+
185+
beforeUid(uid: string): Query;
186+
afterUid(uid: string): Query;
187+
188+
skip(skip: number): Query;
189+
limit(limit: number): Query;
190+
191+
or(...queries: Query[]): Query;
192+
and(...queries: Query[]): Query;
193+
194+
referenceIn(key: string, query: (Query | object)): Query;
195+
referenceNotIn(key: string, query: (Query | object)): Query;
196+
197+
regex(key: string, value: string, options?: string): Query;
198+
141199
search(value: string): Query;
142-
greaterThan(key: string, value: any): Query;
143-
greaterThanOrEqualTo(key: string, value: any): Query;
144-
lessThan(key: string, value: any): Query;
145-
lessThanOrEqualTo(key: string, value: any): Query;
146-
notEqualTo(key: string, value: any): Query;
147-
containedIn(key: string, value: any): Query;
148-
149-
find(): Promise<any>;
150-
findOne(): Promise<any>;
151200

201+
find(fetchOptions?: object): Promise<any>;
202+
findOne(): Promise<any>;
152203
}

‎jest.config.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@ module.exports = {
66
"default",
77
["jest-html-reporters",
88
{
9-
"publicPath": "./html-report",
9+
"publicPath": "./typescript-html-report",
1010
"filename": "report.html",
1111
"expand": true
1212
}
1313
]
14+
],
15+
automock: false,
16+
setupFiles: [
17+
"./test/typescript/setupJest.js"
1418
]
1519
};

‎package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "contentstack",
3-
"version": "3.10.1",
3+
"version": "3.11.0",
44
"description": "Contentstack Javascript SDK",
55
"homepage": "https://www.contentstack.com/",
66
"author": {
@@ -10,10 +10,11 @@
1010
"main": "dist/node/contentstack.js",
1111
"browser": "dist/web/contentstack.js",
1212
"types": "./index.d.ts",
13-
"_id": "contentstack@3.10.1",
13+
"_id": "contentstack@3.11.0",
1414
"scripts": {
15-
"test": "tape test/index.js | tap-html --out ./tap-html.html",
16-
"test:ts": "jest --watchAll --testPathPattern=test/typescript",
15+
"test": "npm run test:e2e && npm run test:typescript",
16+
"test:e2e": "tape test/index.js | tap-html --out ./tap-html.html",
17+
"test:typescript": "jest --testPathPattern=test/typescript",
1718
"automate": "node test.js",
1819
"buildnode": "webpack --config webpack/webpack.node.js",
1920
"buildweb": "webpack -p --config webpack/webpack.web.js",
@@ -50,14 +51,14 @@
5051
],
5152
"dist": {
5253
"shasum": "a328ed07240476a26b31a23261355dc929e1da63",
53-
"tarball": "https://registry.npmjs.org/contentstack/-/contentstack-3.10.1.tgz"
54+
"tarball": "https://registry.npmjs.org/contentstack/-/contentstack-3.11.0.tgz"
5455
},
5556
"license": "MIT",
5657
"directories": {},
57-
"_resolved": "https://registry.npmjs.org/contentstack/-/contentstack-3.10.1.tgz",
58+
"_resolved": "https://registry.npmjs.org/contentstack/-/contentstack-3.11.0.tgz",
5859
"_npmOperationalInternal": {
5960
"host": "packages-18-east.internal.npmjs.com",
60-
"tmp": "tmp/contentstack-3.10.1.tgz_1477830884275_0.9869455888401717"
61+
"tmp": "tmp/contentstack-3.11.0.tgz_1477830884275_0.9869455888401717"
6162
},
6263
"devDependencies": {
6364
"@types/jest": "^26.0.13",

0 commit comments

Comments
 (0)