Skip to content

feat: add image api #11

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: add image api #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
821ad92
feat: add image api
stefan-burdy Feb 2, 2022
24cda8f
feat: minor fixes
stefan-burdy Feb 2, 2022
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
74 changes: 29 additions & 45 deletions packages/web-utils/api/burdy-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { IBurdyPage, IBurdySearch, IBurdyTag, RewritesObject } from '../types';
import axios from 'axios';
import queryString from 'query-string';

export type GetPageOptions = {
draft?: boolean;
Expand Down Expand Up @@ -54,20 +55,24 @@ export type SearchTagsOptions = {
xContentToken?: string;
};

export type OptimizeImageOptions = {
// General
animated?: boolean;
progressive?: boolean;
format?: 'auto' | 'avif' | 'webp' | 'jpeg' | 'jpg' | 'png';
quality?: number;
// Resizing
width?: number;
height?: number;
fit?: 'fill' | 'cover' | 'contain' | 'inside' | 'outside';
gravity?: 'north' | 'northeast' | 'southeast' | 'south' | 'southwest' | 'west' | 'northwest' | 'east' | 'center' | 'centre';
}

export const BurdyApi = {
getPage: async <T = any>(host?: string, slugPath?: string, options?: GetPageOptions): Promise<IBurdyPage<T>> => {
getPage: async <T = any>(host?: string, slugPath?: string, params: GetPageOptions = {}): Promise<IBurdyPage<T>> => {
const headers: Record<string, string> = {};
const params: Record<string, boolean | number | string> = {};

if (options?.includeChildren) params.includeChildren = options.includeChildren;
if (options?.perPage) params.perPage = options.perPage;
if (options?.page) params.page = options.page;

if (options?.xContentToken) headers['x-content-token'] = options?.xContentToken;

if (options?.versionId) params.versionId = options?.versionId;
if (options?.relationsDepth) params.relationsDepth = options?.relationsDepth;
if (options?.draft) params.draft = options?.draft;
if (params?.xContentToken) headers['x-content-token'] = params?.xContentToken;

const { data: page } = await axios.get<IBurdyPage<T>>(`${host}/api/content/${slugPath}`, {
params,
Expand All @@ -76,55 +81,32 @@ export const BurdyApi = {

return page;
},
searchPages: async <T = any>(host: string, options: SearchPagesOptions): Promise<IBurdySearch<IBurdyPage<T>>> => {
searchPages: async <T = any>(host: string, params: SearchPagesOptions): Promise<IBurdySearch<IBurdyPage<T>>> => {
const headers: Record<string, string> = {};
const params: Record<string, boolean | number | string> = {};

if (options?.xContentToken) headers['x-content-token'] = options?.xContentToken;

if (options?.draft) params.draft = true;
if (options?.type) params.type = options.type;
if (options?.contentTypeName) params.contentTypeName = options.contentTypeName;
if (options?.search) params.search = options.search;
if (options?.parent) params.parent = options.parent;
if (options?.onlyOrphans) params.onlyOrphans = options.onlyOrphans;
if (options?.slugPath) params.slugPath = options.slugPath;
if (options?.tags) params.tags = options.tags;
if (options?.expand) params.expand = options.expand;
if (options?.compile) params.compile = options.compile;
if (options?.relationsDepth) params.relationsDepth = options.relationsDepth;
if (options?.orderBy) params.orderBy = options.orderBy;
if (options?.order) params.order = options.order;
if (options?.limit) params.limit = options.limit;
if (options?.page) params.page = options.page;

if (params?.xContentToken) headers['x-content-token'] = params?.xContentToken;
if (params?.draft) params.draft = true;

const { data } = await axios.get<IBurdySearch<IBurdyPage<T>>>(`${host}/api/search/posts`, {
params,
headers
});
return data;
},
searchTags: async (host: string, options: SearchTagsOptions): Promise<IBurdySearch<IBurdyTag>> => {
searchTags: async (host: string, params: SearchTagsOptions): Promise<IBurdySearch<IBurdyTag>> => {
const headers: Record<string, string> = {};
const params: Record<string, boolean | number | string> = {};

if (options?.xContentToken) headers['x-content-token'] = options?.xContentToken;

if (options?.search) params.search = options.search;
if (options?.parent) params.parent = options.parent;
if (options?.onlyOrphans) params.onlyOrphans = options.onlyOrphans;
if (options?.slugPath) params.slugPath = options.slugPath;
if (options?.expand) params.expand = options.expand;
if (options?.orderBy) params.orderBy = options.orderBy;
if (options?.order) params.order = options.order;
if (options?.limit) params.limit = options.limit;
if (options?.page) params.page = options.page;
if (params?.xContentToken) headers['x-content-token'] = params?.xContentToken;

const { data } = await axios.get<IBurdySearch<IBurdyTag>>(`${host}/api/search/tags`, {
params,
headers
});
return data;
},
optimizeImage: async (host: string, npath: string, imageOptions: OptimizeImageOptions): string => {
const query = queryString.stringify(imageOptions, {skipEmptyString: true, skipNull: true});
return `${host}/api/image/${npath}?${query}`;
}
};

Expand All @@ -137,6 +119,7 @@ export type CreateApiType = {
getPage: <T = any>(slugPath: string, options?: GetPageOptions) => Promise<IBurdyPage<T>>;
searchPages: <T = any>(options: SearchPagesOptions) => Promise<IBurdySearch<IBurdyPage<T>>>;
searchTags: (options: SearchTagsOptions) => Promise<IBurdySearch<IBurdyTag>>;
optimizeImage: (npath: string, options: OptimizeImageOptions) => string;
}
export const createApi = (apiConfig: ApiConfig): CreateApiType => ({
getPage: async <T>(slugPath: string, options?: GetPageOptions): Promise<IBurdyPage<T>> => BurdyApi.getPage(apiConfig?.host, slugPath, {
Expand All @@ -150,5 +133,6 @@ export const createApi = (apiConfig: ApiConfig): CreateApiType => ({
searchTags: async (options: SearchTagsOptions): Promise<IBurdySearch<IBurdyTag>> => BurdyApi.searchTags(apiConfig?.host, {
xContentToken: apiConfig?.xContentToken,
...(options || {})
})
}),
optimizeImage: (npath, options): string => BurdyApi.optimizeImage(apiConfig?.host, npath, options)
});
3 changes: 2 additions & 1 deletion packages/web-utils/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"dependencies": {
"deepcopy": "^2.1.0",
"path-to-regexp": "^6.2.0",
"prismjs": "^1.25.0"
"prismjs": "^1.25.0",
"query-string": "^7.1.0"
},
"devDependencies": {
"@types/prismjs": "^1.16.6"
Expand Down
13 changes: 13 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,7 @@ __metadata:
deepcopy: ^2.1.0
path-to-regexp: ^6.2.0
prismjs: ^1.25.0
query-string: ^7.1.0
peerDependencies:
axios: ">= 0.21"
languageName: unknown
Expand Down Expand Up @@ -6906,6 +6907,18 @@ __metadata:
languageName: node
linkType: hard

"query-string@npm:^7.1.0":
version: 7.1.0
resolution: "query-string@npm:7.1.0"
dependencies:
decode-uri-component: ^0.2.0
filter-obj: ^1.1.0
split-on-first: ^1.0.0
strict-uri-encode: ^2.0.0
checksum: 4594a0a092772eb6854310feea85e34f8dcf70df494776a45b9e5be53621ffbcf930ae669974e4e171ce5e0f29a837e9821d48db843106dd94ee390f6f5ac857
languageName: node
linkType: hard

"queue-microtask@npm:^1.2.2":
version: 1.2.3
resolution: "queue-microtask@npm:1.2.3"
Expand Down