@dosgato/templating 0.0.109 → 0.0.111

package/dist/render.d.ts

@@ -1,5 +1,5 @@
 import { ContextBase, DataData, PageData, PageRecord, PageRecordOptionalData } from './component.js';
-import { AssetLink, DataFolderLink, DataLink, LinkDefinition, PageLink } from './links.js';
+import { AssetFolderLink, AssetLink, DataFolderLink, DataLink, LinkDefinition, PageLink } from './links.js';
 export declare function printHeader(ctx: ContextBase, content: string | undefined | null, attributes?: Record<string, string>): string;
 export declare function advanceHeader<T extends ContextBase>(ctx: T, content: string | undefined | null): T;
 export interface PictureResize {
@@ -31,6 +31,19 @@ export interface PictureAttributes {
         widths: PictureResize[];
     }[];
 }
+export interface AssetRecord {
+    id: string;
+    path: string;
+    checksum: string;
+    name: string;
+    extension: string;
+    filename: string;
+    mime: string;
+    size: number;
+    meta: any;
+    downloadLink: string;
+    image?: PictureAttributes;
+}
 export interface PageForNavigation {
     id: string;
     name: string;
@@ -91,6 +104,21 @@ export interface APIClient {
         absolute?: boolean;
         extension?: string;
     }) => string | undefined;
+    /**
+     * Get assets by link
+     *
+     * Certain components will be presenting download links for assets instead of showing images inline. In
+     * those cases, you can use this function instead of getImgAttributes. The result you would get from
+     * getImgAttributes will be inside the `image` property.
+     *
+     * It returns an array of assets because if you provide a link to an asset folder the result will be an
+     * array. So if you provide an asset link you will just get an array of length 1. The recursive parameter
+     * is available if you prefer to receive all assets that descend from the given folder instead of direct child
+     * assets.
+     *
+     * Will be dataloaded so you can safely use this in a Promise.all.
+     */
+    getAssetsByLink: (link: AssetLink | AssetFolderLink | string, recursive?: boolean) => Promise<AssetRecord[]>;
     /**
      * This function will retrieve information about an image to help you construct responsive HTML
      * for a <picture> element including the <img> and all <source> tags.
@@ -99,7 +127,7 @@ export interface APIClient {
      * text gathered from a template's dialog should generally take precedence (though the dialog may
      * preload the alt text field with the asset repository default).
      *
-     * Will be dataloaded.
+     * Will be dataloaded so you can safely use this in a Promise.all.
      */
     getImgAttributes: (link: string | AssetLink | undefined, absolute?: boolean) => Promise<PictureAttributes | undefined>;
     /** Get the data for a specific page.

package/dist/uitemplate.d.ts

@@ -120,5 +120,5 @@ export interface DialogPageProp {
  * A function you may use in your dialogs to make an authenticated graphql request to the DosGato
  * API.
  */
-export declare function dialogQuery<T = any>(query: string, variables: any): Promise<T>;
+export declare function dialogQuery<T = any>(query: string, variables?: any): Promise<T>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.109",
+  "version": "0.0.111",
   "description": "A library to support building templates for dosgato CMS.",
   "type": "module",
   "exports": {