@dosgato/templating 0.0.143 → 0.0.145

package/dist/apitemplate.d.ts

@@ -91,6 +91,37 @@ export interface APITemplate<DataType> {
      * can be done by the routine that calls `getFulltext`.
      */
     getFulltext?: FulltextGatheringFn<DataType>;
+    /**
+     * Extra filters for this template
+     *
+     * Use this function to return arbitrary tags for your template. These tags will be indexed
+     * and may be used later as a search filter.
+     *
+     * For example, pages may set a 'shownInNav' tag and this could be passed to the getNavigation
+     * function during rendering to return a smaller set of pages for navigation.
+     */
+    getTags?: FulltextGatheringFn<DataType>;
+    /**
+     * Copying components around is a core feature in DosGato, but sometimes the data stored
+     * is not suitable for copying, for example unique identifiers generated by FieldIdentifier
+     * should be regenerated during a copy.
+     *
+     * Provide this function to do work like that. It will only be called when content is being
+     * copied, i.e. the original still exists.
+     *
+     * The pageCopy parameter will be true when an entire page is being copied, and false when a
+     * component or data entry is being copied. Sometimes you will want to behave differently in
+     * those cases. For instance, if you generate a unique id and then make references to it on
+     * the same page, you would not want to regenerate those ids during a full page copy because
+     * all the references would break, but you would want to regenerate id on an in-page copy
+     * because you need new ids for the new objects.
+     *
+     * workspace is an initially empty object that onCopy methods from various components can use
+     * as shared memory. You would need this to do something like regenerating ids and also
+     * updating references. You would keep a map of original id -> new id in workspace.mynamespace
+     * and set it any time you encounter an id or reference.
+     */
+    onCopy?: (data: DataType, pageCopy: boolean, workspace: Record<string, any>) => void;
     /**
      * The available component list in the main content area can get very long, among others. Therefore, each
      * template may set a displayCategory and any templates that share a displayCategory will be grouped together

package/dist/provider.js

@@ -8,7 +8,7 @@
  *
  * If you do this, don't forget to register the provider along with your templates!
  */
-class ResourceProvider {
+export class ResourceProvider {
     static webpath(name) { return this.webpaths.get(name); }
 }
 /**
@@ -86,4 +86,3 @@ ResourceProvider.files = new Map();
  * `<img src="${TemplateClass.webpath('keyname')}">`
  */
 ResourceProvider.webpaths = new Map();
-export { ResourceProvider };

package/dist/render.d.ts

@@ -282,6 +282,29 @@ export interface APIClient {
          * The `href` property in the returned records should be an absolute URL.
          */
         absolute?: boolean;
+        /**
+         * Set a filter to use while building the navigation tree, to limit the amount of pages
+         * returned.
+         *
+         * For example, if pages have a `hideInNav` property, you could check that here to avoid
+         * returning pages that are supposed to be hidden.
+         *
+         * You could always do this yourself after getting the full results, but it will improve
+         * performance to do it earlier.
+         */
+        filter?: (page: PageForNavigation) => boolean | undefined;
+        /**
+         * Filter for a specific tag as returned by the template's getTags function in the API
+         * template definition.
+         */
+        tagsAny?: string[];
+        /**
+         * Set a maximum number of children to be displayed in the menu per page.
+         *
+         * For instance, if you set it to 8, no page returned will have more than 8 children. Page
+         * order will determine which 8 make the cut.
+         */
+        maxChildren?: number;
     }) => Promise<PageForNavigation[]>;
     /**
      * Get data entries by link or folder link

package/package.json

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