Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support new REST preview service #100

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
bcb43d2
feat: Support new REST preview service
Deepak-Kharah Oct 23, 2023
7803e7f
feat: make management token optional
Deepak-Kharah Oct 26, 2023
a2f8f84
test: test live preview changes
Deepak-Kharah Oct 26, 2023
8bee6a0
chore: remove failing workflow
Deepak-Kharah Oct 26, 2023
d8c0729
feat: use separate header for preview token
Deepak-Kharah Nov 8, 2023
e831040
refactor: remove logs
Deepak-Kharah Nov 8, 2023
6453bb4
Merge pull request #1 from Deepak-Kharah/EB-550-add-preveiew-token-he…
Deepak-Kharah Nov 8, 2023
645f388
feat: add live preview hash in header
Deepak-Kharah Nov 8, 2023
98d4ab1
fix: typo in the interface name
Deepak-Kharah Nov 22, 2023
82c6d2a
Merge pull request #2 from Deepak-Kharah/EB-634-typo-in-the-interface
Deepak-Kharah Nov 23, 2023
5ef8408
Merge remote-tracking branch 'upstream/master' into VC-311-changes-fo…
Deepak-Kharah Dec 1, 2023
7a3e454
chore: add sca scan
Deepak-Kharah Dec 8, 2023
e9788b4
feat: remove live preview optimization for live editor
Deepak-Kharah Dec 12, 2023
b9faa4b
Merge pull request #3 from Deepak-Kharah/EB-749-remove-live-preview-o…
Deepak-Kharah Dec 12, 2023
0763916
feat: remove caching
Deepak-Kharah Dec 14, 2023
547cbe5
feat: remove content type check from find queries.
Deepak-Kharah Dec 14, 2023
85beba7
fix: add hash check
Deepak-Kharah Dec 14, 2023
d0d2bbd
Merge pull request #4 from Deepak-Kharah/EB-749-remove-live-preview-o…
Deepak-Kharah Jan 11, 2024
9fdcf2d
V3 (#118) (#119)
sunil-lakshman Jan 16, 2024
c0cfcc6
Updated this branch by pulling changes from master branch
harshithad0703 Jan 19, 2024
7c502f3
test: Fixed the failing test case
harshithad0703 Jan 19, 2024
8d845b8
Merge branch 'master' into VC-311-changes-for-rest-preview-service
harshithad0703 Jan 19, 2024
9aa21a2
Merge branch 'next' into VC-311-changes-for-rest-preview-service
harshithad0703 Jan 19, 2024
4564971
Revert "Updated this branch by pulling changes from master branch"
harshithad0703 Jan 22, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '18.x'
node-version: '12.x'
registry-url: 'https://registry.npmjs.org'
- run: npm ci
- run: npm publish
Expand All @@ -25,7 +25,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '18.x'
node-version: '12.x'
registry-url: 'https://npm.pkg.github.com'
scope: '@contentstack'
- run: npm ci
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sca-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ jobs:
env:
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
with:
args: --all-projects --fail-on=all
args: --all-projects --fail-on=all
6 changes: 0 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
## Change log

### Version: 3.18.0
#### Date: January-15-2024
##### New Features:
- added taxonomy support
- X-User-Agent updated
- added region gcp_na
### Version: 3.17.2
#### Date: November-15-2023
##### Bug fix:
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The MIT License (MIT)


Copyright (c) 2016-2024 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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ You can use advanced sync queries to fetch custom results while performing initi

### The MIT License (MIT)

Copyright © 2012-2024 [Contentstack](https://www.contentstack.com). All Rights Reserved
Copyright © 2012-2021 [Contentstack](https://www.contentstack.com). All Rights Reserved

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
5 changes: 2 additions & 3 deletions config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ const config = {
content_types: "/content_types/",
entries: "/entries/",
assets: "/assets/",
environments: "/environments/",
taxonomies: "/taxonomies/entries"
environments: "/environments/"
},
live_preview: {
enable: false,
host: 'api.contentstack.io'
host: 'rest-preview.contentstack.com'
}
};

Expand Down
33 changes: 16 additions & 17 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ export enum Region {
US = "us",
EU = "eu",
AZURE_NA = "azure-na",
AZURE_EU = "azure-eu",
GCP_NA = "gcp-na",
AZURE_EU = "azure-eu"
}

//Enum for Contentstack CachePolicy
Expand Down Expand Up @@ -72,10 +71,21 @@ export interface ContentTypeCollection {
count?: number
}

export interface LivePreview {
host: string
management_token: string
export type LivePreview = {
host?: string
enable: boolean
} & (LivePreivewConfigWithManagementToken | LivePreviewConfigWithPreviewToken)

export interface LivePreivewConfigWithManagementToken {
/**
* @deprecated Please use `preview_token` instead to enable live preview.
* The `management_token` will be removed in future releases.
*/
management_token: string;
}

export interface LivePreviewConfigWithPreviewToken {
preview_token: string;
}

export interface LivePreviewQuery {
Expand Down Expand Up @@ -126,7 +136,6 @@ export class Stack {
ContentType(uid: string): ContentType;
Assets(uid: string): Asset;
Assets(): Assets;
Taxonomies(): Taxonomies;

setPort(port: number): Stack;
setProtocol(protocol: string): Stack;
Expand Down Expand Up @@ -154,13 +163,11 @@ export class ContentType {
constructor();
content_type_uid: string

Query(): Taxonomy;
Query(): Query;
Entry(uid: string): Entry;
fetch(fetchOptions?: object): Promise<any>;
}

export class Taxonomies extends Taxonomy {}

export class Assets {
constructor();

Expand Down Expand Up @@ -281,11 +288,3 @@ export class Query extends Entry {
find(fetchOptions?: object): Promise<any>;
findOne(): Promise<any>;
}

export class Taxonomy extends Query {
constructor();
above(key: string, value: string, levels?: number): Query;
equalAndAbove(key: string, value: string, levels?: number): Query;
below(key: string, value: string, levels?: number): Query;
equalAndBelow(key: string, value: string, levels?: number): Query;
}
Loading
Loading