@sparted/shared-library 1.0.11 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cdn/cdn.factory.d.ts +6 -2
- package/cdn/cdn.factory.js +6 -4
- package/cdn/cdn.factory.js.map +1 -1
- package/cdn/types/cdn-factory.type.d.ts +4 -3
- package/cdn/utils/get-cdn-url.util.d.ts +2 -0
- package/cdn/utils/get-cdn-url.util.js +11 -3
- package/cdn/utils/get-cdn-url.util.js.map +1 -1
- package/package.json +2 -2
package/cdn/cdn.factory.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CdnConfig, CdnType, TransformationQueries } from './types';
|
|
2
2
|
export declare const imgixTransformationQueries: TransformationQueries;
|
|
3
3
|
export declare const twicpicsTransformationQueries: TransformationQueries;
|
|
4
4
|
/**
|
|
@@ -6,6 +6,10 @@ export declare const twicpicsTransformationQueries: TransformationQueries;
|
|
|
6
6
|
* @param type cdn provider: 'twicpics' | 'imgix'
|
|
7
7
|
* @param domain provider domain
|
|
8
8
|
* @param instanceMapper domain + the result of the instanceMapper will form the base path
|
|
9
|
+
* @param cacheVersion
|
|
9
10
|
* @returns \{ getCdnUrl, transformationQueries \}
|
|
10
11
|
*/
|
|
11
|
-
export declare const createCdn:
|
|
12
|
+
export declare const createCdn: <T extends CdnType>({ type, domain, instanceMapper, cacheVersion }: CdnConfig<T>) => {
|
|
13
|
+
getCdnUrl: import("./types").GetCdnUrl;
|
|
14
|
+
getCdnFromS3Url: import("./types").GetCdnFromS3Url;
|
|
15
|
+
};
|
package/cdn/cdn.factory.js
CHANGED
|
@@ -16,7 +16,7 @@ const imgixTransformationQueries = ({ fit, width, height, quality, compress = tr
|
|
|
16
16
|
q: quality !== undefined && quality >= 0 && quality <= 100 ? quality : undefined,
|
|
17
17
|
};
|
|
18
18
|
const searchParams = buildSearchParams.buildSearchParams(params).toString();
|
|
19
|
-
return searchParams ?
|
|
19
|
+
return searchParams ? `${searchParams}` : '';
|
|
20
20
|
};
|
|
21
21
|
const twicpicsTransformationQueries = (params) => {
|
|
22
22
|
if (params.fit !== undefined) {
|
|
@@ -25,13 +25,13 @@ const twicpicsTransformationQueries = (params) => {
|
|
|
25
25
|
console.error('⚠️ The Twicpics api needs a width and a height.');
|
|
26
26
|
return '';
|
|
27
27
|
}
|
|
28
|
-
return
|
|
28
|
+
return `twic=v1/${params.fit}=${params.width}x${params.height}`;
|
|
29
29
|
}
|
|
30
30
|
if (params.width !== undefined) {
|
|
31
31
|
const resizeHeight = params.height !== undefined
|
|
32
32
|
? `x${params.height}`
|
|
33
33
|
: '';
|
|
34
|
-
return
|
|
34
|
+
return `twic=v1/cover=${params.width}${resizeHeight}`;
|
|
35
35
|
}
|
|
36
36
|
return '';
|
|
37
37
|
};
|
|
@@ -40,15 +40,17 @@ const twicpicsTransformationQueries = (params) => {
|
|
|
40
40
|
* @param type cdn provider: 'twicpics' | 'imgix'
|
|
41
41
|
* @param domain provider domain
|
|
42
42
|
* @param instanceMapper domain + the result of the instanceMapper will form the base path
|
|
43
|
+
* @param cacheVersion
|
|
43
44
|
* @returns \{ getCdnUrl, transformationQueries \}
|
|
44
45
|
*/
|
|
45
|
-
const createCdn = ({ type, domain, instanceMapper }) => {
|
|
46
|
+
const createCdn = ({ type, domain, instanceMapper, cacheVersion }) => {
|
|
46
47
|
const getCdnUrl = getCdnUrl_util.getCdnUrlFactory({
|
|
47
48
|
domain,
|
|
48
49
|
instanceMapper,
|
|
49
50
|
transformationQueries: type === 'imgix'
|
|
50
51
|
? imgixTransformationQueries
|
|
51
52
|
: twicpicsTransformationQueries,
|
|
53
|
+
cacheVersion,
|
|
52
54
|
});
|
|
53
55
|
return {
|
|
54
56
|
getCdnUrl,
|
package/cdn/cdn.factory.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cdn.factory.js","sources":["../../src/cdn/cdn.factory.ts"],"sourcesContent":["import { buildSearchParams } from '../http/build-search-params';\nimport type {
|
|
1
|
+
{"version":3,"file":"cdn.factory.js","sources":["../../src/cdn/cdn.factory.ts"],"sourcesContent":["import { buildSearchParams } from '../http/build-search-params';\nimport type { CdnConfig, CdnType, TransformationQueries } from './types';\nimport { getCdnFromS3UrlFactory } from './utils/get-cdn-from-s3-url.util';\nimport { getCdnUrlFactory } from './utils/get-cdn-url.util';\n\nexport const imgixTransformationQueries: TransformationQueries = ({\n fit,\n width,\n height,\n quality,\n compress = true,\n devicePixelRatio,\n}) => {\n const params = {\n auto: compress ? 'compress,format' : undefined,\n fit: fit === 'crop' ? 'crop' : undefined,\n dpr: Number.isFinite(devicePixelRatio) ? devicePixelRatio : undefined,\n h: Number.isFinite(height) ? height : undefined,\n w: Number.isFinite(width) ? width : undefined,\n q: quality !== undefined && quality >= 0 && quality <= 100 ? quality : undefined,\n };\n const searchParams = buildSearchParams(params).toString();\n\n return searchParams ? `${searchParams}` : '';\n};\n\nexport const twicpicsTransformationQueries: TransformationQueries = (\n params,\n) => {\n if (params.fit !== undefined) {\n if (params.width === undefined || params.height === undefined) {\n // eslint-disable-next-line no-console\n console.error('⚠️ The Twicpics api needs a width and a height.');\n return '';\n }\n\n return `twic=v1/${params.fit}=${params.width}x${params.height}`;\n }\n if (params.width !== undefined) {\n const resizeHeight = params.height !== undefined\n ? `x${params.height}`\n : '';\n\n return `twic=v1/cover=${params.width}${resizeHeight}`;\n }\n\n return '';\n};\n\n/**\n *\n * @param type cdn provider: 'twicpics' | 'imgix'\n * @param domain provider domain\n * @param instanceMapper domain + the result of the instanceMapper will form the base path\n * @param cacheVersion\n * @returns \\{ getCdnUrl, transformationQueries \\}\n */\nexport const createCdn = <T extends CdnType>({ type, domain, instanceMapper, cacheVersion }: CdnConfig<T>) => {\n const getCdnUrl = getCdnUrlFactory({\n domain,\n instanceMapper,\n transformationQueries:\n type === 'imgix'\n ? imgixTransformationQueries\n : twicpicsTransformationQueries,\n cacheVersion,\n });\n\n return {\n getCdnUrl,\n getCdnFromS3Url: getCdnFromS3UrlFactory({\n getCdnUrl,\n }),\n };\n};\n"],"names":["buildSearchParams","getCdnUrlFactory","getCdnFromS3UrlFactory"],"mappings":";;;;;;;;MAKa,0BAA0B,GAA0B,CAAC,EAChE,GAAG,EACH,KAAK,EACL,MAAM,EACN,OAAO,EACP,QAAQ,GAAG,IAAI,EACf,gBAAgB,GACjB,KAAI;AACH,IAAA,MAAM,MAAM,GAAG;QACb,IAAI,EAAE,QAAQ,GAAG,iBAAiB,GAAG,SAAS;QAC9C,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,MAAM,GAAG,SAAS;AACxC,QAAA,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,GAAG,SAAS;AACrE,QAAA,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,SAAS;AAC/C,QAAA,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,SAAS;AAC7C,QAAA,CAAC,EAAE,OAAO,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,IAAI,OAAO,IAAI,GAAG,GAAG,OAAO,GAAG,SAAS;KACjF,CAAC;IACF,MAAM,YAAY,GAAGA,mCAAiB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,YAAY,GAAG,CAAA,EAAG,YAAY,CAAA,CAAE,GAAG,EAAE,CAAC;AAC/C,EAAE;AAEW,MAAA,6BAA6B,GAA0B,CAClE,MAAM,KACJ;AACF,IAAA,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE;QAC5B,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;;AAE7D,YAAA,OAAO,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;AAClE,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AAED,QAAA,OAAO,CAAW,QAAA,EAAA,MAAM,CAAC,GAAG,CAAI,CAAA,EAAA,MAAM,CAAC,KAAK,CAAI,CAAA,EAAA,MAAM,CAAC,MAAM,EAAE,CAAC;AACjE,KAAA;AACD,IAAA,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;AAC9B,QAAA,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,KAAK,SAAS;AAC9C,cAAE,CAAA,CAAA,EAAI,MAAM,CAAC,MAAM,CAAE,CAAA;cACnB,EAAE,CAAC;AAEP,QAAA,OAAO,iBAAiB,MAAM,CAAC,KAAK,CAAG,EAAA,YAAY,EAAE,CAAC;AACvD,KAAA;AAED,IAAA,OAAO,EAAE,CAAC;AACZ,EAAE;AAEF;;;;;;;AAOG;AACI,MAAM,SAAS,GAAG,CAAoB,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,YAAY,EAAgB,KAAI;IAC3G,MAAM,SAAS,GAAGC,+BAAgB,CAAC;QACjC,MAAM;QACN,cAAc;QACd,qBAAqB,EACnB,IAAI,KAAK,OAAO;AACd,cAAE,0BAA0B;AAC5B,cAAE,6BAA6B;QACnC,YAAY;AACb,KAAA,CAAC,CAAC;IAEH,OAAO;QACL,SAAS;QACT,eAAe,EAAEC,2CAAsB,CAAC;YACtC,SAAS;SACV,CAAC;KACH,CAAC;AACJ;;;;;;"}
|
|
@@ -18,13 +18,14 @@ export declare type TransformationQueries = (params: Transformation) => string;
|
|
|
18
18
|
export declare type GetCdnUrl = (instanceId: string, path: `/${string}`, params?: CdnParams) => string;
|
|
19
19
|
export declare type GetCdnFromS3Url = (url: string, params?: CdnParams) => string;
|
|
20
20
|
export declare type InstanceMapper = (instanceId: string) => string;
|
|
21
|
-
export declare type
|
|
22
|
-
|
|
21
|
+
export declare type CdnType = 'twicpics' | 'imgix';
|
|
22
|
+
export declare type CdnConfig<T extends CdnType> = {
|
|
23
|
+
type: T;
|
|
23
24
|
domain: `https://${string}`;
|
|
24
25
|
instanceMapper: InstanceMapper;
|
|
26
|
+
cacheVersion?: T extends 'twicpics' ? number : undefined;
|
|
25
27
|
};
|
|
26
28
|
export declare type Cdn = {
|
|
27
29
|
getCdnUrl: GetCdnUrl;
|
|
28
30
|
getCdnFromS3Url: GetCdnFromS3Url;
|
|
29
31
|
};
|
|
30
|
-
export declare type CreateCdn = (config: CdnConfig) => Cdn;
|
|
@@ -3,6 +3,8 @@ declare type FactoryConfig = {
|
|
|
3
3
|
domain: `https://${string}`;
|
|
4
4
|
instanceMapper: InstanceMapper;
|
|
5
5
|
transformationQueries: TransformationQueries;
|
|
6
|
+
cacheVersion?: number;
|
|
6
7
|
};
|
|
8
|
+
export declare const genCacheVersionQuery: (cacheVersion?: number) => string;
|
|
7
9
|
export declare const getCdnUrlFactory: (config: FactoryConfig) => GetCdnUrl;
|
|
8
10
|
export {};
|
|
@@ -2,12 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
const DEFAULT_THUMBNAIL_CONFIG = {
|
|
5
|
+
const DEFAULT_THUMBNAIL_CONFIG = {
|
|
6
|
+
width: 300,
|
|
7
|
+
height: 300,
|
|
8
|
+
};
|
|
9
|
+
const genCacheVersionQuery = (cacheVersion) => (cacheVersion ? `v=${cacheVersion}` : '');
|
|
6
10
|
const getCdnUrlFactory = (config) => (instanceId, path, params = {}) => {
|
|
7
|
-
const { domain, instanceMapper, transformationQueries } = config;
|
|
11
|
+
const { domain, instanceMapper, transformationQueries, cacheVersion, } = config;
|
|
8
12
|
const { transformation = params.asThumbnail ? DEFAULT_THUMBNAIL_CONFIG : {}, } = params;
|
|
9
|
-
|
|
13
|
+
const transformationQuery = transformationQueries(transformation);
|
|
14
|
+
const cacheVersionQuery = genCacheVersionQuery(cacheVersion);
|
|
15
|
+
const hasQueryParams = [transformationQuery, cacheVersionQuery].some((query) => query !== '');
|
|
16
|
+
return `${domain}${instanceMapper(instanceId)}${path}${hasQueryParams ? '?' : ''}${transformationQuery}${cacheVersionQuery ? `&${cacheVersionQuery}` : ''}`;
|
|
10
17
|
};
|
|
11
18
|
|
|
19
|
+
exports.genCacheVersionQuery = genCacheVersionQuery;
|
|
12
20
|
exports.getCdnUrlFactory = getCdnUrlFactory;
|
|
13
21
|
//# sourceMappingURL=get-cdn-url.util.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-cdn-url.util.js","sources":["../../../src/cdn/utils/get-cdn-url.util.ts"],"sourcesContent":["import type {\n GetCdnUrl,\n InstanceMapper,\n Transformation,\n TransformationQueries,\n} from '../types';\n\nconst DEFAULT_THUMBNAIL_CONFIG: Transformation = {
|
|
1
|
+
{"version":3,"file":"get-cdn-url.util.js","sources":["../../../src/cdn/utils/get-cdn-url.util.ts"],"sourcesContent":["import type {\n GetCdnUrl,\n InstanceMapper,\n Transformation,\n TransformationQueries,\n} from '../types';\n\nconst DEFAULT_THUMBNAIL_CONFIG: Transformation = {\n width: 300,\n height: 300,\n};\n\ntype FactoryConfig = {\n domain: `https://${string}`;\n instanceMapper: InstanceMapper;\n transformationQueries: TransformationQueries;\n cacheVersion?: number;\n};\n\nexport const genCacheVersionQuery = (cacheVersion?: number) => (cacheVersion ? `v=${cacheVersion}` : '');\n\nexport const getCdnUrlFactory = (config: FactoryConfig): GetCdnUrl => (instanceId, path, params = {}) => {\n const {\n domain,\n instanceMapper,\n transformationQueries,\n cacheVersion,\n } = config;\n\n const {\n transformation = params.asThumbnail ? DEFAULT_THUMBNAIL_CONFIG : {},\n } = params;\n\n const transformationQuery: string = transformationQueries(transformation);\n const cacheVersionQuery = genCacheVersionQuery(cacheVersion);\n const hasQueryParams = [transformationQuery, cacheVersionQuery].some((query) => query !== '');\n\n return `${domain}${instanceMapper(\n instanceId,\n )}${path}${hasQueryParams ? '?' : ''}${transformationQuery}${cacheVersionQuery ? `&${cacheVersionQuery}` : ''}`;\n};\n"],"names":[],"mappings":";;;;AAOA,MAAM,wBAAwB,GAAmB;AAC/C,IAAA,KAAK,EAAE,GAAG;AACV,IAAA,MAAM,EAAE,GAAG;CACZ,CAAC;MASW,oBAAoB,GAAG,CAAC,YAAqB,MAAM,YAAY,GAAG,KAAK,YAAY,CAAA,CAAE,GAAG,EAAE,EAAE;AAE5F,MAAA,gBAAgB,GAAG,CAAC,MAAqB,KAAgB,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,KAAI;IACtG,MAAM,EACJ,MAAM,EACN,cAAc,EACd,qBAAqB,EACrB,YAAY,GACb,GAAG,MAAM,CAAC;AAEX,IAAA,MAAM,EACJ,cAAc,GAAG,MAAM,CAAC,WAAW,GAAG,wBAAwB,GAAG,EAAE,GACpE,GAAG,MAAM,CAAC;AAEX,IAAA,MAAM,mBAAmB,GAAW,qBAAqB,CAAC,cAAc,CAAC,CAAC;AAC1E,IAAA,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;AAC7D,IAAA,MAAM,cAAc,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;AAE9F,IAAA,OAAO,CAAG,EAAA,MAAM,CAAG,EAAA,cAAc,CAC/B,UAAU,CACX,CAAG,EAAA,IAAI,GAAG,cAAc,GAAG,GAAG,GAAG,EAAE,CAAG,EAAA,mBAAmB,CAAG,EAAA,iBAAiB,GAAG,CAAI,CAAA,EAAA,iBAAiB,EAAE,GAAG,EAAE,EAAE,CAAC;AAClH;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sparted/shared-library",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.12",
|
|
4
4
|
"repository": "git@github.com:Sparted/shared-library.git",
|
|
5
5
|
"author": "Thomas <duprethomasfr@gmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -58,4 +58,4 @@
|
|
|
58
58
|
"^.+\\.(t|j)s$": "ts-jest"
|
|
59
59
|
}
|
|
60
60
|
}
|
|
61
|
-
}
|
|
61
|
+
}
|