Skip to content

Commit 83edbbf

Browse files
uttamukkojiuttamukkoji
authored
Merge pull request #37 from contentstack/request_retry
Fetch retry and Typescript definitions
2 parents a560569 + 8e152db commit 83edbbf

File tree

15 files changed

+9213
-3244
lines changed

15 files changed

+9213
-3244
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

‎.npmignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ contentstack-templates/
88
js-sdk-reference/
99
examples/
1010
mocktest.json
11+
webpack
12+
typescript-html-report

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
### Version: 3.11.0
2+
#### Date: Sept-25-2020
3+
4+
##### Update API:
5+
- Retry limit for fetch request
6+
- Retry delay options for fetch request
7+
- Retry on error occur for fetch request
8+
- Typescript definition added
9+
10+
##### Enhancement Documentation
11+
- Documentation update for Only and Except
12+
13+
114
### Version: 3.10.1
215
#### Date: Jun-29-2020
316

‎index.d.ts‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
// Type definitions for contentstack 3.11.0
2+
// Project: https://www.contentstack.com/
3+
// Definitions by: Contentstack <https://github.com/contentstack>
4+
5+
//Enum for Contentstack Region
6+
export enum Region {
7+
US = "us",
8+
EU = "eu"
9+
}
10+
11+
//Enum for Contentstack CachePolicy
12+
export enum CachePolicy {
13+
IGNORE_CACHE = -1,
14+
ONLY_NETWORK = 0,
15+
CACHE_ELSE_NETWORK = 1,
16+
NETWORK_ELSE_CACHE = 2,
17+
CACHE_THEN_NETWORK = 3
18+
}
19+
20+
// Sync Result
21+
export interface SyncResult {
22+
items: Array<any>;
23+
paginationToken?: string;
24+
syncToken?: string;
25+
skip: number;
26+
limit: number;
27+
totalCount: number;
28+
}
29+
30+
// Contentstack Config
31+
export interface Config {
32+
api_key: string;
33+
delivery_token: string;
34+
environment: string;
35+
region?: Region;
36+
fetchOptions?: object;
37+
}
38+
// Stack Config
39+
export interface StackConfig {
40+
protocol: string;
41+
host: string;
42+
port: number;
43+
version: string;
44+
}
45+
46+
// ContentTypeCollection
47+
export interface ContentTypeCollection{
48+
contentTypes: Array<any>
49+
count?: number
50+
}
51+
52+
// Stack
53+
export class Stack {
54+
constructor(config: Config);
55+
constructor(api_key: string, delivery_token: string, environment_name: string, region?: Region, fetchOptions?: any);
56+
57+
environment: string;
58+
cachePolicy: CachePolicy;
59+
config: StackConfig;
60+
fetchOptions: any;
61+
62+
ContentType(uid: string): ContentType;
63+
Assets(uid: string): Asset;
64+
Assets(): Assets;
65+
66+
setPort(port: number): Stack;
67+
setProtocol(protocol: string): Stack;
68+
setHost(host: string): Stack;
69+
setCachePolicy(policy: CachePolicy): Stack;
70+
setCacheProvider(provider: object): Stack;
71+
clearByQuery(): Stack;
72+
clearByContentType(): Stack;
73+
clearAll(): Stack;
74+
getCacheProvider(): object;
75+
getLastActivites(): Promise<any>;;
76+
getContentTypes(param?: object): Promise<ContentTypeCollection>;
77+
sync(params: object): Promise<SyncResult>;
78+
imageTransform(url: string, params: any): string;
79+
}
80+
81+
export function Stack(config: Config): Stack;
82+
export function Stack(api_key: string, access_token: string, environment_name: string, region?: string, fetchOptions?: object): Stack;
83+
84+
export class ContentType {
85+
constructor();
86+
content_type_uid: string
87+
88+
Query(): Query;
89+
Entry(uid: string): Entry;
90+
fetch(fetchOptions?: object): Promise<any>;
91+
}
92+
93+
export class Assets {
94+
constructor();
95+
96+
toJSON(): Assets;
97+
addParam(key: string, value: any): Assets;
98+
Query(): Query;
99+
100+
}
101+
102+
export class Asset {
103+
constructor();
104+
105+
asset_uid: string
106+
107+
toJSON(): Assets;
108+
addParam(key: string, value: any): Assets;
109+
fetch(fetchOptions?: object): Promise<any>;
110+
}
111+
112+
export class Entry {
113+
constructor();
114+
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+
132+
setCacheProvider(provider: object): Entry;
133+
setCachePolicy(policy: number): Entry;
134+
includeReference(val: string[]): Entry;
135+
includeReference(...val: string[]): Entry;
136+
language(language_code: string): Entry;
137+
addQuery(key: string, value: string): Entry;
138+
139+
/**
140+
* @deprecated since verion 3.3.0
141+
*/
142+
includeSchema(): Entry;
143+
includeReferenceContentTypeUID(): Entry;
144+
includeContentType(): Entry;
145+
includeOwner(): Entry;
146+
toJSON(): Entry;
147+
addParam(key: string, value: any): Entry;
148+
fetch(fetchOptions?: object): Promise<any>;
149+
}
150+
151+
export class Query extends Entry {
152+
constructor();
153+
_query: object;
154+
155+
getQuery(): Query;
156+
157+
includeCount(): Query;
158+
query(query: object): Query;
159+
count(fetchOptions?: object): Query;
160+
161+
referenceIn(key: string, query: Query): Query;
162+
referenceNotIn(key: string, query: Query): 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+
199+
search(value: string): Query;
200+
201+
find(fetchOptions?: object): Promise<any>;
202+
findOne(): Promise<any>;
203+
}

‎jest.config.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = {
2+
preset: 'ts-jest',
3+
testEnvironment: 'node',
4+
forceExit:true,
5+
reporters: [
6+
"default",
7+
["jest-html-reporters",
8+
{
9+
"publicPath": "./typescript-html-report",
10+
"filename": "report.html",
11+
"expand": true
12+
}
13+
]
14+
],
15+
};

0 commit comments

Comments
 (0)