bruce-models 7.1.129 → 7.1.130

package/dist/types/report/report-template.d.ts

@@ -0,0 +1,136 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+/**
+ * Reusable report definitions whose ordered sections are separate ReportTemplateSection records.
+ * These calls require an API deployment that supports the Report Template concepts.
+ */
+export declare namespace ReportTemplate {
+    /**
+     * Database bigint identity; decimal strings preserve IDs beyond JavaScript's safe integer range.
+     */
+    type TId = number | string;
+    /**
+     * JSON settings for the report's main structure; the API does not prescribe their internal schema.
+     */
+    type TSettings = {
+        [key: string]: unknown;
+    };
+    /**
+     * A report template, without its sections; load those through ReportTemplateSection.GetList.
+     */
+    interface ITemplate {
+        /**
+         * Database-assigned identity. Omit or use 0 when creating a template.
+         */
+        ID?: TId;
+        /**
+         * Display name, required on creation; 1 to 200 characters and not entirely whitespace.
+         */
+        Name?: string;
+        /**
+         * Optional explanation of the template's purpose. Null clears it on update.
+         */
+        Description?: string | null;
+        /**
+         * Server-assigned creator, preserved on update and ignored in request bodies.
+         */
+        "Created.ByUser.ID"?: string;
+        /**
+         * Server-assigned creation time in ISO 8601 format, preserved on update.
+         */
+        "Created.DateTime"?: string;
+        /**
+         * Main report settings. Null clears them; section settings belong on each section record.
+         */
+        Settings?: TSettings | null;
+    }
+    /**
+     * Inputs for reading a single template in the current account and session.
+     */
+    interface IGetParams {
+        api?: BruceApi.Api;
+        /**
+         * Positive identity of the template to read.
+         */
+        reportTemplateId: TId;
+        req?: Api.IReqParams;
+    }
+    /**
+     * The template returned by a single-record read or save.
+     */
+    interface IGetRes {
+        reportTemplate: ITemplate;
+    }
+    /**
+     * Inputs for listing all templates visible to the current account session; no paging is supported.
+     */
+    interface IGetListParams {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }
+    /**
+     * Visible templates ordered by Name ascending, then ID ascending to break ties.
+     */
+    interface IGetListRes {
+        reportTemplates: ITemplate[];
+    }
+    /**
+     * Inputs for creating or updating a template; omitted fields retain their existing values.
+     */
+    interface IUpdateParams {
+        api?: BruceApi.Api;
+        /**
+         * Template fields to save. Name is required when creating; metadata is server-controlled.
+         */
+        reportTemplate: ITemplate;
+        /**
+         * Overrides reportTemplate.ID. Omit both IDs, or use 0, to create a template.
+         */
+        reportTemplateId?: TId;
+        req?: Api.IReqParams;
+    }
+    /**
+     * The saved template, including its identity and creation metadata.
+     */
+    interface IUpdateRes {
+        reportTemplate: ITemplate;
+    }
+    /**
+     * Inputs for deleting a template and all of its sections atomically.
+     */
+    interface IDeleteParams {
+        api?: BruceApi.Api;
+        reportTemplateId: TId;
+        req?: Api.IReqParams;
+    }
+    /**
+     * Validates and normalizes a signed 64-bit identity for routes and cache keys without rounding it.
+     * Zero is accepted only for creation; decimal strings can represent the full positive bigint range.
+     */
+    function NormalizeId(id: TId, allowZero?: boolean): string;
+    /**
+     * Reads a template by ID, subject to the caller's template view permission.
+     */
+    function Get(params: IGetParams): Promise<IGetRes>;
+    /**
+     * Lists visible templates in name order; the server filters out records the caller cannot view.
+     */
+    function GetList(params?: IGetListParams): Promise<IGetListRes>;
+    /**
+     * Creates with ID 0 or updates the identified template, preserving omitted fields on the server.
+     * Explicit null clears Description or Settings; identity and creation metadata come from the server.
+     */
+    function Update(params: IUpdateParams): Promise<IUpdateRes>;
+    /**
+     * Deletes a template and every section it owns; requires template delete permission.
+     */
+    function Delete(params: IDeleteParams): Promise<void>;
+    /**
+     * Cache identifier for one template, shared by numeric IDs and their decimal string equivalents.
+     */
+    function GetCacheKey(reportTemplateId: TId): string;
+    /**
+     * Cache identifier for the account's visible template list.
+     */
+    function GetListCacheKey(): string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "7.1.129",
+    "version": "7.1.130",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",