Merge branch 'master' into umb-build

Author: Khaledgarbaya

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 We appreciate any community contributions to this project, whether in the form of issues or Pull Requests.
 
-This document outlines the we'd like you to follow in terms of commit messages and code style.
+This document outlines what we'd like you to follow in terms of commit messages and code style.
 
 It also explains what to do in case you want to setup the project locally and run tests.
 

README.md

@@ -61,7 +61,7 @@ Check the [releases](https://github.com/contentful/contentful.js/releases) page
 
 ## Authentication
 
-To get content from Contentful, an app should authenticate with an with an OAuth bearer token.
+To get content from Contentful, an app should authenticate with an OAuth bearer token.
 
 You can create API keys using [Contentful's web interface](https://app.contentful.com). Go to the app, open the space that you want to access (top left corner lists all the spaces), and navigate to the APIs area. Open the API Keys section and create your first token. Done.
 

index.d.ts

@@ -0,0 +1,111 @@
+// Type definitions for contentful
+// Definitions by: Miika Hänninen <https://github.com/googol>
+
+export interface CreateClientParams {
+    space: string;
+    accessToken: string;
+    insecure?: boolean;
+    host?: string;
+    agent?: any;
+    headers?: any;
+    concurrency?: number;
+    delay?: number;
+    maxRetries?: number;
+    retryOnTooManyRequests?: boolean;
+    resolveLinks?: boolean;
+}
+
+export interface ContentfulClientApi {
+    getAsset(id: string, query?: any): Promise<Asset>;
+    getAssets(query?: any): Promise<AssetCollection>;
+    getContentType(id: string): Promise<ContentType>;
+    getContentTypes(query?: any): Promise<ContentTypeCollection>;
+    getEntries(query?: any): Promise<EntryCollection<any>>;
+    getEntry(id: string, query?: any): Promise<Entry<any>>;
+    getSpace(): Promise<Space>;
+    sync(query: any): Promise<SyncCollection>;
+}
+
+export interface Asset {
+    sys: Sys;
+    fields: {
+        title: string;
+        description: string;
+        file: {
+            url: string;
+            details: any;
+            fileNmae: string;
+            contentType: string;
+        };
+    };
+    toPlainObject(): Asset;
+}
+
+export interface ContentfulCollection<T> {
+    total: number;
+    skip: number;
+    limit: number;
+    items: Array<T>;
+    toPlainObject(): this;
+}
+
+export type AssetCollection = ContentfulCollection<Asset>
+
+export interface Entry<T> {
+    sys: Sys;
+    fields: T;
+    toPlainObject(): Entry<T>;
+}
+
+export interface EntryCollection<T> extends ContentfulCollection<Entry<T>> {
+    errors?: Array<any>;
+    includes?: any;
+    stringifySafe(replacer: any, space: any): string;
+}
+
+export interface ContentType {
+    sys: Sys;
+    name: string;
+    description: string;
+    displayField: string;
+    Array: string;
+    toPlainObject(): ContentType;
+}
+
+export type ContentTypeCollection = ContentfulCollection<ContentType>;
+
+export interface Space {
+    sys: Sys;
+    name: string;
+    locales: Array<string>;
+    toPlainObject(): Space;
+}
+
+export interface SyncCollection {
+    entries: Array<Entry<any>>;
+    assets: Array<Asset>;
+    deletedEntries: Array<Entry<any>>;
+    deletedAssets: Array<Asset>;
+    nextSyncToken: string;
+    toPlainObject(): SyncCollection;
+    stringifySafe(replacer: any, space: any): string;
+}
+
+export interface Sys {
+    type: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    locale: string;
+    contentType: {
+        sys: ContentTypeLink;
+    };
+}
+
+export interface ContentTypeLink {
+    type: 'Link';
+    linkType: 'ContentType';
+    id: string;
+}
+
+export function createClient(params: CreateClientParams): ContentfulClientApi;

package.json

@@ -39,6 +39,7 @@
     "devdep:install": "npm run devdep:build && rm -rf node_modules/contentful-sdk-core && npm install ../contentful-sdk-core && npm run devdep:clean",
     "devdep:uninstall": "npm run devdep:clean && rimraf node_modules/contentful-sdk-core"
   },
+  "types": "./index.d.ts",
   "files": [
     "index.js",
     "version.js",