@dosgato/templating 1.1.16 → 1.1.17

package/dist/component.js

@@ -13,40 +13,6 @@ export class Component extends ResourceProvider {
      * Provide this when you create a template to identify what you are defining.
      */
     static templateKey;
-    /**
-     * The rendering server will provide an instance of the APIClient interface so that
-     * you can run any API GraphQL query you like in your `fetch` function. There are also
-     * some useful methods there like processRich to help you convert links in rich text
-     * strings.
-     *
-     * Do NOT mutate data received from the API as it may be cached and given to other
-     * Component instances that run the same type of query.
-     */
-    api;
-    /**
-     * This property will be set during page render and you may refer to it at any time to
-     * determine whether you are doing your work in edit mode or regular rendering mode.
-     * The editBar and newBar methods will automatically use it to blank out the editing UI.
-     */
-    editMode;
-    /**
-     * The extension of the variation currently being rendered.
-     *
-     * See 'renderVariation' and 'variationsToFetch' for more discussion of variations.
-     */
-    extension;
-    /**
-     * When hydrating an inherited component, the renderer will set this to the id of the page it
-     * came from. You may use this information in any of the phases to alter your behavior if needed.
-     *
-     * For instance, you may decide that your fetch function needs some extra information from the
-     * originating page instead of the page you're being inherited into (your `this.page` will
-     * be the page currently being rendered, NOT the page the inheritable component came from).
-     *
-     * This property is also used to alter the edit bar. Inherited components may never be edited
-     * except on their original page, so the edit bar will render with a link to the original page.
-     */
-    inheritedFrom;
     /**
      * The first phase of rendering a component is the fetch phase. Each component may
      * provide a fetch method that looks up data it needs from external sources. This step
@@ -89,17 +55,6 @@ export class Component extends ResourceProvider {
      * '.js.map', you should receive 'js.map'.
      */
     shouldFetchVariation(extension) { return extension === 'html'; }
-    /**
-     * Some components may be inheritable to subpages within the same site. For instance, a site's
-     * social media links may appear on every page's footer. To accomplish this in your template,
-     * you need to fetch ancestor page data in your fetch phase, identify the component data you want
-     * to inherit, and then call this function within your fetch to let the renderer know it needs to
-     * process those components (hydrate them, call their fetch functions, and include them in the render).
-     *
-     * The inherited components will be added to the appropriate area's array in the renderedAreas
-     * parameter of your render function.
-     */
-    registerInherited;
     /**
      * Inherit components from another page with matching area
      *
@@ -134,44 +89,6 @@ export class Component extends ResourceProvider {
     setContext(renderCtxFromParent, areaName) {
         return renderCtxFromParent;
     }
-    /**
-     * This function will be provided by the rendering server and should be used inside your fetch
-     * method to prepare editor-provided HTML for later rendering. It will do things like find and
-     * resolve link definitions in the internal dosgato format.
-     */
-    fetchRichText;
-    /**
-     * This function will be provided by the rendering server and should be used during the render
-     * phase to clean up editor-provided HTML. It will do things like clean up tags that were accidentally
-     * left open to protect overall page integrity, and fix header levels for accessibility.
-     *
-     * For instance, an editor supplies a title to be placed above some rich editor content. The
-     * title uses an <h2>, so the headers inside the rich editor content should start at <h3> and
-     * should not use <h1> or <h2>.
-     *
-     * Setting headerLevel: 3 instructs the renderRichText function to analyze and rebalance the header
-     * structure of the content so that if it had an h2, it woud be replaced with an h3. Additionally,
-     * if the user skipped a header level (a WCAG violation) that situation will be repaired as well
-     * as possible.
-     *
-     * If you do not provide a headerLevel, the one from `this.renderCtx` will be used. However, if you
-     * provide a non-blank value for `advanceHeader`, the headerLevel from `this.renderCtx` + 1 will be used.
-     *
-     * This way you can easily render a piece of rich text in a component that has an optional title:
-     *
-     * this.renderRichText(this.data.richtext, { advanceHeader: this.data.title })
-     *
-     * If this.data.title is non-blank, the rich text will be balanced below it, but if it is blank,
-     * it will be balanced at the level the title would have had.
-     */
-    renderRichText;
-    /**
-     * When we give editors the ability to enter raw HTML, we still need to minimally process it to
-     * protect the rest of the page from unclosed tags and other syntax problems, but we don't want
-     * to muck around with headers or links, so this function will be provided by the render server
-     * and will only do the parsing and reconstruction part
-     */
-    renderRawHTML;
     /**
      * If you are rendering a variation for a component that has areas and children,
      * you can call Component.renderVariation(extension, this.renderedAreas) to help you easily

package/package.json

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