Merge pull request #88 from contentstack/feature/plugin-support

Plugin Support | Users can use custom plugins with Delivery SDK

Author: nadeem-cs

CHANGELOG.md

@@ -1,9 +1,15 @@
 ## Change log
 
+### Version: 3.16.0
+#### Date: February-10-2023
+#####  New Features:
+ - Plugin Support Added
+
 ### Version: 3.15.3
 #### Date: July-26-2022
 #####  New Features:
  - Live preview with reference in entry on SSR web app issue resolved
+
 ### Version: 3.15.2
 #### Date: May-03-2022
 #####  New Features:

LICENSE.txt

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
 
-Copyright (c) 2016-2022 Contentstack
+Copyright (c) 2016-2023 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for contentstack 3.12.2
+// Type definitions for contentstack v3.12.2 and above
 // Project: https://www.contentstack.com/
 // Definitions by: Contentstack <https://github.com/contentstack>
 import { EntryEmbedable, Option, RenderOption } from '@contentstack/utils'
@@ -52,6 +52,7 @@ export interface Config {
     region?: Region;
     branch?: string;
     live_preview?: LivePreview;
+    plugins?: ContentstackPlugin[];
     fetchOptions?: FetchOptions;
 }
 // Stack Config
@@ -63,7 +64,7 @@ export interface StackConfig {
 }
 
 // ContentTypeCollection
-export interface ContentTypeCollection{
+export interface ContentTypeCollection {
     content_types: Array<any>
     count?: number
 }
@@ -94,6 +95,17 @@ export interface FetchOptions {
     retryDelayOptions?: RetryDelayOption
 }
 
+//Plugins
+export interface ContentstackPlugin {
+    onRequest?(stack: Stack, request: ContentstackRequest): ContentstackRequest;
+    onResponse?(stack: Stack, request: ContentstackRequest, response: any, data: any): any;
+}
+
+export interface ContentstackRequest {
+    url: string;
+    option: object;
+}
+
 // Stack 
 export class Stack {
     constructor(config: Config);