@dosgato/templating 0.0.5 → 0.0.8

package/dist/links.d.ts

@@ -7,9 +7,8 @@ export interface AssetLink {
     type: 'asset';
     source: string;
     id: string;
-    siteId: string;
-    path: string;
-    checksum: string;
+    path?: string;
+    checksum?: string;
 }
 /**
  * Some components (e.g. document list) can point at a folder instead of individual
@@ -20,7 +19,6 @@ export interface AssetFolderLink {
     type: 'assetfolder';
     source: string;
     id: string;
-    siteId: string;
     path: string;
 }
 /**
@@ -29,7 +27,6 @@ export interface AssetFolderLink {
 export interface PageLink {
     type: 'page';
     linkId: string;
-    siteId: string;
     path: string;
 }
 /**
@@ -50,8 +47,9 @@ export interface WebLink {
  */
 export interface DataLink {
     type: 'data';
+    templateKey: string;
     id: string;
-    siteId: string | null;
+    siteId?: string;
     path: string;
 }
 /**

package/dist/provider.d.ts

@@ -1,3 +1,20 @@
+export interface CSSBlock {
+    css?: string;
+    path?: string;
+    version?: string;
+    async?: boolean;
+}
+export interface JSBlock {
+    js?: string;
+    path?: string;
+    version?: string;
+    async?: boolean;
+}
+export interface FileDeclaration {
+    path: string;
+    version?: string;
+    mime: string;
+}
 /**
  * This class is a parent class for Component, but it can also be used as a standalone
  * if you are creating a set of templates with shared resources. This will be fairly
@@ -20,22 +37,23 @@ export declare abstract class ResourceProvider {
      * version number of any given name will be used. Other versions of that name will be ignored.
      *
      * For convenience you can either provide the `css` property with the CSS as a string, or the
-     * `path` property with the full server path to a CSS file (node's __dirname function will
+     * `path` property with the full server path (NOT URL) to a CSS file (node's __dirname function will
      * help you determine it). You MUST provide one or the other.
+     *
+     * You may also set `async` to true if a css block is not needed for the initial render of
+     * the page. For instance, if your component has a modal that the user can trigger, you can
+     * defer the CSS for that modal since it will not be needed until the page has gone interactive
+     * and the user has clicked something.
      */
-    static cssBlocks: Map<string, {
-        css?: string;
-        path?: string;
-        version?: string;
-    }>;
+    static cssBlocks: Map<string, CSSBlock>;
     /**
      * Same as cssBlocks() but for javascript.
+     *
+     * In this case `async` is much more useful, as most javascript is interactive and could run
+     * after the page renders. Any code that adds event observers or the like should be marked with
+     * async to improve the initial render time.
      */
-    static jsBlocks: Map<string, {
-        js?: string;
-        path?: string;
-        version?: string;
-    }>;
+    static jsBlocks: Map<string, JSBlock>;
     /**
      * If your template needs to serve any files, like fonts or images, you can provide
      * a filesystem path in this static property and the files will be served by the rendering
@@ -58,11 +76,7 @@ export declare abstract class ResourceProvider {
      * DO NOT change the mime type without changing the name. Other templates could end up with
      * the wrong file extension.
      */
-    static files: Map<string, {
-        path: string;
-        version?: string;
-        mime: string;
-    }>;
+    static files: Map<string, FileDeclaration>;
     /**
      * Template code will need to generate HTML and CSS that points at the static files
      * provided above. In order to do so, we need information from the template registry (since

package/dist/provider.js

@@ -27,12 +27,21 @@ exports.ResourceProvider = ResourceProvider;
  * version number of any given name will be used. Other versions of that name will be ignored.
  *
  * For convenience you can either provide the `css` property with the CSS as a string, or the
- * `path` property with the full server path to a CSS file (node's __dirname function will
+ * `path` property with the full server path (NOT URL) to a CSS file (node's __dirname function will
  * help you determine it). You MUST provide one or the other.
+ *
+ * You may also set `async` to true if a css block is not needed for the initial render of
+ * the page. For instance, if your component has a modal that the user can trigger, you can
+ * defer the CSS for that modal since it will not be needed until the page has gone interactive
+ * and the user has clicked something.
  */
 ResourceProvider.cssBlocks = new Map();
 /**
  * Same as cssBlocks() but for javascript.
+ *
+ * In this case `async` is much more useful, as most javascript is interactive and could run
+ * after the page renders. Any code that adds event observers or the like should be marked with
+ * async to improve the initial render time.
  */
 ResourceProvider.jsBlocks = new Map();
 /**

package/dist/uitemplate.d.ts

@@ -0,0 +1,8 @@
+import { IconifyIcon } from '@iconify/svelte';
+import { SvelteComponent } from 'svelte';
+export interface UITemplate {
+    templateKey: string;
+    dialog: SvelteComponent;
+    preview?: IconifyIcon;
+    icon?: IconifyIcon;
+}

package/dist/uitemplate.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.5",
+  "version": "0.0.8",
   "description": "A library to support building templates for dosgato CMS.",
   "exports": {
     "require": "./dist/index.js",
@@ -11,7 +11,10 @@
     "prepublishOnly": "npm run build",
     "build": "rm -rf dist && tsc"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@iconify/svelte": "^2.2.1",
+    "svelte": "^3.48.0"
+  },
   "devDependencies": {
     "eslint-config-standard-with-typescript": "^21.0.1",
     "typescript": "^4.4.2"