@stackbit/types - npm Package Compare versions

Comparing version 0.8.3-develop.1 to 0.8.3-develop.2

dist/asset-source.d.ts

@@ -1,2 +0,2 @@
-export declare type AssetSource = AssetSourceCloudinary | AssetSourceBynder | AssetSourceIframe;
+export declare type AssetSource = AssetSourceCloudinary | AssetSourceBynder | AssetSourceAprimo | AssetSourceIframe;
 export interface AssetSourceCloudinary {
@@ -46,2 +46,24 @@ type: 'cloudinary';
 }
+export interface AssetSourceAprimo {
+    type: 'aprimo';
+    /**
+     * if not specified defaults to 'aprimo'
+     */
+    name?: string;
+    /**
+     * Aprimo asset preview function
+     * If not specified will default to:
+     * ({ value }) => {
+     *   title: value?.title,
+     *   image: value?.rendition?.publicuri
+     * }
+     */
+    preview?: AssetPreview;
+    /**
+     * asset transform function, if not specified will use the asset "as is"
+     */
+    transform?: (options: {
+        assetData: any;
+    }) => any;
+}
 export interface AssetSourceIframe {
@@ -48,0 +70,0 @@ type: 'iframe';

dist/asset-source.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"asset-source.d.ts","sourceRoot":"","sources":["../src/asset-source.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW,GAAG,qBAAqB,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAExF,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,oBAAY,YAAY,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AACrE,oBAAY,oBAAoB,GAAG,CAAC,OAAO,EAAE;IAAE,SAAS,EAAE,GAAG,CAAA;CAAE,KAAK,kBAAkB,CAAC;AACvF,MAAM,WAAW,kBAAkB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"asset-source.d.ts","sourceRoot":"","sources":["../src/asset-source.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW,GAAG,qBAAqB,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAE5G,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,GAAG,CAAC;CACpD;AAED,oBAAY,YAAY,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AACrE,oBAAY,oBAAoB,GAAG,CAAC,OAAO,EAAE;IAAE,SAAS,EAAE,GAAG,CAAA;CAAE,KAAK,kBAAkB,CAAC;AACvF,MAAM,WAAW,kBAAkB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB"}

package.json

 {
   "name": "@stackbit/types",
-  "version": "0.8.3-develop.1",
+  "version": "0.8.3-develop.2",
   "description": "Types for Stackbit config and Content Source Interface",
@@ -30,3 +30,3 @@ "main": "dist/index.js",
   "homepage": "https://github.com/stackbit/stackbit#readme",
-  "gitHead": "e66429069fc7db0a3f97a33bebd3e7744140a236"
+  "gitHead": "3689787b100e19b53139cd2262b677986d5aeda3"
 }

src/asset-source.ts

@@ -1,2 +0,2 @@
-export type AssetSource = AssetSourceCloudinary | AssetSourceBynder | AssetSourceIframe;
+export type AssetSource = AssetSourceCloudinary | AssetSourceBynder | AssetSourceAprimo | AssetSourceIframe;
 
@@ -45,2 +45,23 @@ export interface AssetSourceCloudinary {
 
+export interface AssetSourceAprimo {
+    type: 'aprimo';
+    /**
+     * if not specified defaults to 'aprimo'
+     */
+    name?: string;
+    /**
+     * Aprimo asset preview function
+     * If not specified will default to:
+     * ({ value }) => {
+     *   title: value?.title,
+     *   image: value?.rendition?.publicuri
+     * }
+     */
+    preview?: AssetPreview;
+    /**
+     * asset transform function, if not specified will use the asset "as is"
+     */
+    transform?: (options: { assetData: any }) => any;
+}
+
 export interface AssetSourceIframe {
@@ -47,0 +68,0 @@ type: 'iframe';

No alert changes

Improved metrics

Total package byte prevSize

294743

0.45%

Lines of code

5378

0.79%

No dependency changes