@dosgato/templating 0.0.135 → 0.0.136

package/dist/apitemplate.d.ts

@@ -179,8 +179,18 @@ export interface APIDataTemplate<DataType extends DataData = any> extends APITem
      * Data template implementations receive the id of the dataroot the data is/will be inside,
      * as well as the folder id (if applicable) and their own id. Keep in mind dataId will be
      * null when it is a creation operation.
+     *
+     * nameIsTaken will be true when the automatically generated name for the data entry already
+     * exists elsewhere in the folder. This fact can be ignored and the generated name will be automatically
+     * numerated to be unique. If you would rather present the editor with a validation error and let them resolve
+     * the conflict, this parameter gives you an opportunity to do that.
+     *
+     * Note that numeration can lead to the name changing during unrelated edits, possibly breaking
+     * links. For example, on creation the name is set with a "-1" suffix because of a conflict, then
+     * the conflicting entry is deleted. Editing this data entry again will remove the "-1" because
+     * of the lack of conflict.
      */
-    validate?: (data: DataType, extras: DataExtras) => Promise<ValidationFeedback[]>;
+    validate?: (data: DataType, extras: DataExtras, nameIsTaken: boolean) => Promise<ValidationFeedback[]>;
     migrations?: DataMigration<DataType>[];
     /**
      * Mark this data type as inappropriate for sites. For example, if you have system-wide configuration
@@ -188,6 +198,27 @@ export interface APIDataTemplate<DataType extends DataData = any> extends APITem
      * true to avoid showing the site list and stop allowing data of this type to be attached to sites.
      */
     global?: boolean;
+    /**
+     * Mark this data type as inappropriate for global. For example, if you have a data type for site
+     * configurations, a global entry might make no sense. Setting this will avoid showing editors
+     * the global space in the dataroot list.
+     */
+    noglobal?: boolean;
+    /**
+     * Data objects must have names so that they can be linked to at a specific path. However,
+     * for an editor, setting an addressable name for a data entry that already has, say, a
+     * title, is both tedious and confusing.
+     *
+     * Instead, it is the data template developer's responsibility to create the name from
+     * the data gathered from the editor. If there is a title, that's a great option. Otherwise,
+     * the dialog may need to have an explicit `name` field. Either way it's up to the developer
+     * of each data template to decide and provide.
+     *
+     * Whatever is returned from this function will be further processed to fit well in a path -
+     * i.e. lower-cased and non-word characters replaced by a dash. If there is a duplicate data
+     * entry in the same folder, it will be automatically numerated.
+     */
+    computeName: (data: DataType) => string;
 }
 export type APIAnyTemplate = APIComponentTemplate | APIPageTemplate | APIDataTemplate;
 /**

package/dist/component.d.ts

@@ -360,6 +360,25 @@ export interface PageRecord<DataType extends PageData = PageData> {
 export interface PageRecordOptionalData<DataType extends PageData = PageData> extends Omit<PageRecord<DataType>, 'data'> {
     data?: DataType;
 }
+export interface DataRecord<DataType extends DataData = DataData> {
+    id: string;
+    name: string;
+    linkId: string;
+    createdAt: Date;
+    createdBy: {
+        id: string;
+        name: string;
+    };
+    modifiedAt: Date;
+    modifiedBy: {
+        id: string;
+        name: string;
+    };
+    publishedAt?: Date;
+    path: string;
+    data: DataType;
+    site?: SiteInfo;
+}
 export interface ComponentData {
     templateKey: string;
     areas?: Record<string, ComponentData[]>;

package/dist/render.d.ts

@@ -1,4 +1,4 @@
-import type { ContextBase, DataData, PageData, PageRecord, PageRecordOptionalData } from './component.js';
+import type { ContextBase, DataRecord, PageData, PageRecord, PageRecordOptionalData } from './component.js';
 import type { AssetFolderLink, AssetLink, DataFolderLink, DataLink, LinkDefinition, PageLink } from './links.js';
 /**
  * Safely encapsulates `content` in header tags based on the `ctx` context passed and adds any passed `attributes` to the header tagging.
@@ -52,14 +52,6 @@ export interface AssetRecord {
     downloadLink: string;
     image?: PictureAttributes;
 }
-export interface DataRecord {
-    id: string;
-    path: string;
-    name: string;
-    modifiedAt: Date;
-    publishedAt?: Date;
-    data: DataData;
-}
 export interface PageForNavigation {
     id: string;
     name: string;

package/dist/uitemplate.d.ts

@@ -1,4 +1,4 @@
-import type { ComponentData, PageData } from './component.js';
+import type { ComponentData, DataData, PageData, DataRecord } from './component.js';
 interface IconifyIcon {
     body: string;
     rotate?: number;
@@ -12,7 +12,7 @@ interface IconifyIcon {
 export interface IconOrSVG extends IconifyIcon {
     raw?: true;
 }
-export interface UITemplate {
+export interface UITemplateBase {
     templateKey: string;
     /**
      * A svelte component that expects to be inside a @dosgato/dialog Form component
@@ -52,6 +52,21 @@ export interface UITemplate {
      * For example, `randomId: 'id'` means your component data will look like `{ id: 'cym87regpk' }`
      */
     randomId?: string;
+    /**
+     * if present this SVG will be used when presenting users with
+     * an array of choices of templates to create. Ideally it should look
+     * a lot like the template will look on a webpage. It will be presented
+     * about 1-2 inches wide
+     */
+    preview?: IconOrSVG;
+    /**
+     * if present this icon will be used to represent the template in various
+     * UI contexts. It will be presented about 3mm wide. Falls back to the
+     * preview image.
+     */
+    icon?: IconOrSVG;
+}
+export interface UITemplate extends UITemplateBase {
     /**
      * Sometimes when you create a component that has areas, you want to automatically fill
      * one or more areas with some default introductory content.
@@ -67,19 +82,6 @@ export interface UITemplate {
      * }
      */
     defaultContent?: Record<string, ComponentData[]> | ((data: ComponentData) => Record<string, ComponentData[]>);
-    /**
-     * if present this SVG will be used when presenting users with
-     * an array of choices of templates to create. Ideally it should look
-     * a lot like the template will look on a webpage. It will be presented
-     * about 1-2 inches wide
-     */
-    preview?: IconOrSVG;
-    /**
-     * if present this icon will be used to represent the template in various
-     * UI contexts. It will be presented about 3mm wide. Falls back to the
-     * preview image.
-     */
-    icon?: IconOrSVG;
     /**
      * Add buttons to the page bar in the page editing UI when editing pages with this
      * template. Only applies to page templates.
@@ -107,6 +109,30 @@ export interface UITemplate {
         shouldAppear?: (data: PageData, path: string) => boolean;
     }[];
 }
+export interface UITemplateData extends UITemplateBase {
+    /**
+     * Without configuration, only data entry names and modified dates are shown
+     * in the list view. Use this to configure your own set of columns.
+     */
+    columns?: {
+        /**
+         * A title for the column in header row.
+         */
+        title: string;
+        /**
+         * If given a string, will be treated as a dot-separated path within DataData and
+         * the content at that path will be html-encoded and placed inside the field.
+         *
+         * If given a function, the result of the function will be placed inside the field
+         * without html-encoding, so that you can write your own HTML. Do the encoding yourself.
+         */
+        get: string | ((data: DataRecord) => string);
+        /**
+         * An icon for the cell in all regular rows (not the header).
+         */
+        icon?: (data: DataData) => IconOrSVG;
+    }[];
+}
 /**
  * This is a type for the data that will be passed to dialog Svelte components as
  * the `page` prop. Note that page template dialogs do NOT receive this prop.

package/package.json

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