@encodeagent/platform-helper-util 1.2603.1071502 → 1.2603.1311023

package/dist/record.d.ts

@@ -23,25 +23,72 @@ export interface IRecord {
     organizationId: string;
     solutionId: string;
     createdBy: string;
-    createdOn: number;
+    createdAt: number;
     ownedBy: string;
-    ownedOn: number;
+    ownedAt: number;
     modifiedBy: string;
-    modifiedOn: number;
+    modifiedAt: number;
     partitionKey: string;
     isPublished?: boolean;
     isGlobal?: boolean;
+    isPublishedBy?: string;
+    isPublishedAt?: string;
+    isGlobalBy?: string;
+    isGlobalAt?: string;
+    stateCode: number;
+    statusCode: number;
     [key: string]: any;
 }
+/**
+ * Strips server-managed and identity fields from a record so it can be submitted as a
+ * new create payload. Removes audit timestamps, CosmosDB system properties (`_rid`,
+ * `_self`, etc.), computed fields (`slug`, `searchDisplay`, `display`), and platform
+ * fields (`stateCode`, `statusCode`, `organizationId`, `solutionId`, `partitionKey`).
+ * Assigns a fresh GUID as `id`.
+ */
 export declare const convertRecordForCreate: (record: Record<string, any>) => Record<string, any>;
 export interface IGetBaseRecordProps extends IContext {
     entityName: string;
     entityType?: string;
 }
+/**
+ * Creates a minimal valid `IRecord` shell with a new GUID and audit fields populated
+ * from the provided context. All timestamps are set to the current moment.
+ * `partitionKey` is set to `organizationId` (CosmosDB convention).
+ */
 export declare const getBaseRecord: (context: IGetBaseRecordProps) => IRecord;
+/**
+ * Returns the first non-empty string value found by iterating `displayFields` in order.
+ * Used internally by `getRecordDisplay` when an entity defines explicit display field names.
+ */
 export declare const getRecordDisplayByDisplayFields: (record: Record<string, any>, displayFields?: string[]) => string;
+/**
+ * Returns a folder path string derived from a record's `entityName` and `entityType`.
+ * Format: `"entityName/entityType"` or just `"entityName"` when `entityNameOnly` is true
+ * or when `entityType` is absent. Returns `"Unknown"` when both are empty.
+ */
 export declare const getRecordEntityFolder: (data: Record<string, any>, entityNameOnly: boolean) => string;
+/**
+ * Builds a storage folder path from explicit `entityName` and optional `entityType` strings
+ * (rather than reading from a record object). Returns `"Unknown"` when `entityName` is empty.
+ */
 export declare const getEntityFolder: (entityName: string, entityType?: string) => string;
+/**
+ * Resolves the best human-readable display label for a record.
+ *
+ * Resolution priority:
+ * 1. Search highlight title (`_ui.highlight.title`)
+ * 2. `searchDisplay` (when `includeSearchDisplay` is true)
+ * 3. Entity `displayFields` (first non-empty field)
+ * 4. `firstName + lastName` full name
+ * 5. `displayValue`
+ * 6. `number – title` / `number – name` / `number – subject`
+ * 7. `display`, `text`, `symbol`, `code`
+ *
+ * The result is cleaned (normalizes whitespace and punctuation spacing) and optionally
+ * truncated to `maxLength` characters. Returns the record `id` when `allowUseRecordId`
+ * is true and no other value could be resolved.
+ */
 export declare const getRecordDisplay: (record: Record<string, any>, settings?: {
     entity?: Record<string, any>;
     displayFields?: string[];
@@ -50,13 +97,38 @@ export declare const getRecordDisplay: (record: Record<string, any>, settings?:
     emptyReturnUndefined?: boolean;
     allowUseRecordId?: boolean;
 }) => string | undefined;
+/**
+ * Resolves the best short abstract/description text for a record.
+ *
+ * Resolution priority:
+ * 1. Search highlight (`highlight.searchContent[0]`)
+ * 2. `summary`, `description`, `abstract`
+ * 3. `searchContent` (only when `settings.includeContent` is true)
+ *
+ * Whitespace and punctuation are normalized before returning.
+ * Truncates to `settings.maxLength` characters when provided.
+ */
 export declare const getRecordAbstract: (record: Record<string, any>, settings?: {
     entity?: Record<string, any>;
     abstractFields?: string[];
     maxLength?: number;
     includeContent?: boolean;
 }) => string;
+/**
+ * Returns the first non-empty string value found by iterating `contentFields` in order.
+ * Used internally by `getRecordContent` when an entity defines explicit content field names.
+ */
 export declare const getRecordContentByContentFields: (record: Record<string, any>, contentFields?: string[]) => string;
+/**
+ * Resolves the main body content for a record, suitable for indexing or display.
+ *
+ * Resolution priority:
+ * 1. Search highlight (`_ui.highlight.content`)
+ * 2. `searchContent` (when `includeSearchDisplay` is true)
+ * 3. Entity/settings `contentFields` (defaults to description, note, detail, content, …)
+ *
+ * Truncates to `maxLength` when provided.
+ */
 export declare const getRecordContent: (record: Record<string, any>, settings?: {
     entity?: Record<string, any>;
     contentFields?: string[];
@@ -64,18 +136,60 @@ export declare const getRecordContent: (record: Record<string, any>, settings?:
     maxLength?: number;
     emptyReturnUndefined?: boolean;
 }) => string | undefined;
+/**
+ * Formats a complete postal address from prefixed address fields on a record
+ * (e.g. `prefix = "billing"` reads `billingLine1`, `billingCity`, `billingState`, …).
+ * Returns `""` when the record does not contain the minimum required fields
+ * (city + state + country, or postalCode + country).
+ */
 export declare const getRecordAddress: (record: Record<string, any>, prefix: string) => string;
+/**
+ * Returns the primary media URL for a record, trying `media`, `photoUrl`, and
+ * `source.photoUrl` in that order. Returns `""` when none are set.
+ */
 export declare const getRecordMedia: (record: Record<string, any>) => string;
+/**
+ * Constructs a display name for a user-like record.
+ *
+ * Resolution order: `fullName` → `firstName + lastName` → `name` → `email`.
+ * `skipFullNameProp`, `skipNameProp`, `skipEmailProp` let callers exclude specific steps.
+ * Simplified Chinese locale (Windows locale code 2052) has spaces stripped from the assembled name.
+ * Multiple consecutive spaces are collapsed to a single space.
+ */
 export declare const getRecordFullName: (user: Record<string, any>, settings?: {
     skipFullNameProp?: boolean;
     skipNameProp?: boolean;
     skipEmailProp?: boolean;
 }) => string;
+/**
+ * Returns a formatted email address string for a record that has a valid `email` field.
+ * Format: `"Full Name <email@example.com>"`, or just `"email@example.com"` when
+ * `emailOnly` is true or no display name is available.
+ * Returns `undefined` when the record has no valid email.
+ */
 export declare const getRecordEmailAddress: (record: Record<string, any>, emailOnly?: boolean) => string | undefined;
+/**
+ * Builds an Open Graph / page metadata object for a record, suitable for `<head>` tags.
+ * Returns `{ id, title, description, type: "article", image? }`.
+ * Title is derived from `getRecordDisplay` (or `getRecordAbstract` when display is empty),
+ * optionally prefixed with `settings.siteName`.
+ */
 export declare const getRecordPageMetadata: (record: Record<string, any>, settings?: {
     siteName?: string;
 }) => Record<string, any>;
+/**
+ * Computes the current slug via `getRecordSlug` and ensures it is present in both
+ * `record.slug` (current) and `record.slugs` (historical list, deduplicated).
+ * Call this before persisting a record to keep slug history intact for redirects.
+ */
 export declare const applyRecordSlug: (record: Record<string, any>) => Record<string, any>;
+/**
+ * Derives a URL slug for a record.
+ * Uses `record.customSlug` when set; otherwise derives from `getRecordDisplay`.
+ * The slug is truncated to 128 characters and suffixed with the second GUID segment
+ * of the record ID (e.g. `"my-post-e29b"`) to guarantee global uniqueness.
+ * Returns `undefined` when the record has no `id`.
+ */
 export declare const getRecordSlug: (record: Record<string, any>) => string | undefined;
 export type TRecordFilePath = {
     solutionId: string;
@@ -84,9 +198,33 @@ export type TRecordFilePath = {
     entityName: string;
     fieldName?: string;
 };
+/**
+ * Builds the storage path for a file attached to a record.
+ * Format: `"{solutionId}/{organizationId}/{entityName}/{recordId}/{fieldName}"`.
+ * `fieldName` defaults to `"file"` when not provided.
+ */
 export declare const getRecordFilePath: (props: TRecordFilePath) => string;
+/**
+ * Extracts an `IContext` from a record that carries context fields directly
+ * (e.g. an API request body that has been enriched with caller context).
+ * Picks `solutionId`, `domain`, `sourceIp`, `userId`, `organizationId`,
+ * `user`, `organization`, and `solution`.
+ */
 export declare const getContextFromRecord: (record: Record<string, any>) => IContext;
+/**
+ * Returns true when a record is marked global but belongs to a different organization
+ * than the one in the current context. Used to identify marketplace/shared content.
+ */
 export declare const fromOtherOrganization: (context: IContext, record: Record<string, any>) => boolean;
+/**
+ * Returns true when the record's ID appears in the current user's favorites list
+ * for the record's entity type (`context.user.favorites[entityName]`).
+ */
 export declare const isFavorite: (context: IContext, record: Record<string, any>) => boolean;
+/**
+ * Returns true when a record is global and its owning organization differs from the
+ * current context's organization. Equivalent to `fromOtherOrganization` but compares
+ * against `context.organization.id` instead of `context.organizationId`.
+ */
 export declare const isFromMarketplace: (context: Record<string, any>, record: Record<string, any>) => boolean;
 //# sourceMappingURL=record.d.ts.map

package/dist/record.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,eAAO,MAAM,sBAAsB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,wBA6BjE,CAAC;AAEF,MAAM,WAAW,mBAAoB,SAAQ,QAAQ;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,aAAa,GAAI,SAAS,mBAAmB,KAAG,OAkB5D,CAAA;AAED,eAAO,MAAM,+BAA+B,GACxC,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,gBAAgB,MAAM,EAAE,WAa3B,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAC9B,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,gBAAgB,OAAO,KACxB,MAOF,CAAC;AAEF,eAAO,MAAM,eAAe,GACxB,YAAY,MAAM,EAClB,aAAa,MAAM,KACpB,MAMF,CAAC;AAEF,eAAO,MAAM,gBAAgB,GACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B,KACF,MAAM,GAAG,SAoFX,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC1B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,KACF,MA8CF,CAAC;AAEF,eAAO,MAAM,+BAA+B,GACxC,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,gBAAgB,MAAM,EAAE,WAa3B,CAAC;AAEF,eAAO,MAAM,gBAAgB,GACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC,KACF,MAAM,GAAG,SAoDX,CAAC;AAEF,eAAO,MAAM,gBAAgB,GACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,QAAQ,MAAM,KACf,MAiCF,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAO5D,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC1B,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,WAAW;IACP,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B,KACF,MAmCF,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,YAAY,OAAO,KACpB,MAAM,GAAG,SAWX,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,wBA0BnC,CAAC;AAEF,eAAO,MAAM,eAAe,GACxB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,MAAM,CAAC,MAAM,EAAE,GAAG,CAUpB,CAAC;AAEF,eAAO,MAAM,aAAa,GACtB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,MAAM,GAAG,SAaX,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAI,OAAO,eAAe,KAAG,MAI1D,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,QAqBlE,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAC9B,SAAS,QAAQ,EACjB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAIF,CAAC;AAEF,eAAO,MAAM,UAAU,GACnB,SAAS,QAAQ,EACjB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAGF,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC1B,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAIF,CAAC"}
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,wBA6BjE,CAAC;AAEF,MAAM,WAAW,mBAAoB,SAAQ,QAAQ;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,SAAS,mBAAmB,KAAG,OAkB5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,+BAA+B,GACxC,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,gBAAgB,MAAM,EAAE,WAS3B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAC9B,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,gBAAgB,OAAO,KACxB,MAOF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,YAAY,MAAM,EAAE,aAAa,MAAM,KAAG,MAIzE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB,GACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B,KACF,MAAM,GAAG,SAkFX,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,GAC1B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,KACF,MAqCF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,+BAA+B,GACxC,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,gBAAgB,MAAM,EAAE,WAS3B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,GACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC,KACF,MAAM,GAAG,SA4CX,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,MAAM,KAAG,MAoB9E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAM5D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAC1B,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,WAAW;IACP,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B,KACF,MA2BF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,YAAY,OAAO,KACpB,MAAM,GAAG,SAWX,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,WAAW;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,wBA0BnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAU/E,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAAM,GAAG,SAapE,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,eAAe,KAAG,MAI1D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,QAalE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAAI,SAAS,QAAQ,EAAE,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,OAEtF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,SAAS,QAAQ,EAAE,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,OAG3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC1B,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5B,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAEF,CAAC"}

package/dist/record.js

@@ -21,14 +21,21 @@ exports.isFromMarketplace = exports.isFavorite = exports.fromOtherOrganization =
 const lodash_1 = require("lodash");
 const core_1 = require("./core");
 const slug_1 = require("./slug");
+/**
+ * Strips server-managed and identity fields from a record so it can be submitted as a
+ * new create payload. Removes audit timestamps, CosmosDB system properties (`_rid`,
+ * `_self`, etc.), computed fields (`slug`, `searchDisplay`, `display`), and platform
+ * fields (`stateCode`, `statusCode`, `organizationId`, `solutionId`, `partitionKey`).
+ * Assigns a fresh GUID as `id`.
+ */
 const convertRecordForCreate = (record) => {
     const newRecord = (0, lodash_1.cloneDeep)(record);
     delete newRecord.createdBy;
-    delete newRecord.createdOn;
+    delete newRecord.createdAt;
     delete newRecord.ownedBy;
-    delete newRecord.ownedOn;
+    delete newRecord.ownedAt;
     delete newRecord.modifiedBy;
-    delete newRecord.modifiedOn;
+    delete newRecord.modifiedAt;
     delete newRecord["_rid"];
     delete newRecord["_self"];
     delete newRecord["_etag"];
@@ -52,6 +59,11 @@ const convertRecordForCreate = (record) => {
     return newRecord;
 };
 exports.convertRecordForCreate = convertRecordForCreate;
+/**
+ * Creates a minimal valid `IRecord` shell with a new GUID and audit fields populated
+ * from the provided context. All timestamps are set to the current moment.
+ * `partitionKey` is set to `organizationId` (CosmosDB convention).
+ */
 const getBaseRecord = (context) => {
     const { userId, organizationId, solutionId, entityName, entityType } = context;
     return {
@@ -59,11 +71,11 @@ const getBaseRecord = (context) => {
         entityName,
         entityType,
         createdBy: userId,
-        createdOn: (0, core_1.getTimestamp)(),
+        createdAt: (0, core_1.getTimestamp)(),
         ownedBy: userId,
-        ownedOn: (0, core_1.getTimestamp)(),
+        ownedAt: (0, core_1.getTimestamp)(),
         modifiedBy: userId,
-        modifiedOn: (0, core_1.getTimestamp)(),
+        modifiedAt: (0, core_1.getTimestamp)(),
         stateCode: 0,
         statusCode: 0,
         organizationId,
@@ -72,6 +84,10 @@ const getBaseRecord = (context) => {
     };
 };
 exports.getBaseRecord = getBaseRecord;
+/**
+ * Returns the first non-empty string value found by iterating `displayFields` in order.
+ * Used internally by `getRecordDisplay` when an entity defines explicit display field names.
+ */
 const getRecordDisplayByDisplayFields = (record, displayFields) => {
     let result = "";
     if (displayFields && (0, lodash_1.isArray)(displayFields) && !(0, core_1.isNonEmptyString)(result)) {
@@ -82,24 +98,47 @@ const getRecordDisplayByDisplayFields = (record, displayFields) => {
     return result;
 };
 exports.getRecordDisplayByDisplayFields = getRecordDisplayByDisplayFields;
+/**
+ * Returns a folder path string derived from a record's `entityName` and `entityType`.
+ * Format: `"entityName/entityType"` or just `"entityName"` when `entityNameOnly` is true
+ * or when `entityType` is absent. Returns `"Unknown"` when both are empty.
+ */
 const getRecordEntityFolder = (data, entityNameOnly) => {
     let entityFolder = (0, core_1.isNonEmptyString)(data.entityType) && !entityNameOnly
         ? `${data.entityName ?? ""}/${data.entityType}`
-        : data.entityName ?? "";
+        : (data.entityName ?? "");
     if (entityFolder.length == 0)
         entityFolder = "Unknown";
     return entityFolder;
 };
 exports.getRecordEntityFolder = getRecordEntityFolder;
+/**
+ * Builds a storage folder path from explicit `entityName` and optional `entityType` strings
+ * (rather than reading from a record object). Returns `"Unknown"` when `entityName` is empty.
+ */
 const getEntityFolder = (entityName, entityType) => {
-    let entityFolder = (0, core_1.isNonEmptyString)(entityType)
-        ? `${entityName}/${entityType}`
-        : entityName;
+    let entityFolder = (0, core_1.isNonEmptyString)(entityType) ? `${entityName}/${entityType}` : entityName;
     if (entityFolder.length == 0)
         entityFolder = "Unknown";
     return entityFolder;
 };
 exports.getEntityFolder = getEntityFolder;
+/**
+ * Resolves the best human-readable display label for a record.
+ *
+ * Resolution priority:
+ * 1. Search highlight title (`_ui.highlight.title`)
+ * 2. `searchDisplay` (when `includeSearchDisplay` is true)
+ * 3. Entity `displayFields` (first non-empty field)
+ * 4. `firstName + lastName` full name
+ * 5. `displayValue`
+ * 6. `number – title` / `number – name` / `number – subject`
+ * 7. `display`, `text`, `symbol`, `code`
+ *
+ * The result is cleaned (normalizes whitespace and punctuation spacing) and optionally
+ * truncated to `maxLength` characters. Returns the record `id` when `allowUseRecordId`
+ * is true and no other value could be resolved.
+ */
 const getRecordDisplay = (record, settings) => {
     if (!(0, core_1.isObject)(record))
         return "";
@@ -115,15 +154,12 @@ const getRecordDisplay = (record, settings) => {
     if (includeSearchDisplay && !(0, core_1.isNonEmptyString)(result, true)) {
         result = record.searchDisplay;
     }
-    if (displayFields &&
-        (0, lodash_1.isArray)(displayFields) &&
-        !(0, core_1.isNonEmptyString)(result, true)) {
+    if (displayFields && (0, lodash_1.isArray)(displayFields) && !(0, core_1.isNonEmptyString)(result, true)) {
         result = (0, exports.getRecordDisplayByDisplayFields)(record, displayFields);
     }
     if (!(0, core_1.isNonEmptyString)(result, true))
         result = (0, exports.getRecordFullName)(record);
-    if (!(0, core_1.isNonEmptyString)(result, true) &&
-        (0, core_1.isNonEmptyString)(record.displayValue, true)) {
+    if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.displayValue, true)) {
         result = record.displayValue;
     }
     const number = !(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.number, true)
@@ -135,8 +171,7 @@ const getRecordDisplay = (record, settings) => {
     if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.name, true)) {
         result = `${number}${record.name}`;
     }
-    if (!(0, core_1.isNonEmptyString)(result, true) &&
-        (0, core_1.isNonEmptyString)(record.subject, true)) {
+    if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.subject, true)) {
         result = `${number}${record.subject}`;
     }
     if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.display, true)) {
@@ -145,8 +180,7 @@ const getRecordDisplay = (record, settings) => {
     if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.text, true)) {
         result = record.text;
     }
-    if (!(0, core_1.isNonEmptyString)(result, true) &&
-        (0, core_1.isNonEmptyString)(record.symbol, true)) {
+    if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.symbol, true)) {
         result = record.symbol;
     }
     if (!(0, core_1.isNonEmptyString)(result, true) && (0, core_1.isNonEmptyString)(record.code, true)) {
@@ -167,19 +201,26 @@ const getRecordDisplay = (record, settings) => {
     if ((0, lodash_1.isNumber)(maxLength) && result.length > maxLength) {
         result = `${result.substring(0, maxLength)} ...`;
     }
-    return (((0, core_1.isNonEmptyString)(result, true)
-        ? result
-        : allowUseRecordId
-            ? record.id
-            : "") ?? (settings?.emptyReturnUndefined ? undefined : ""));
+    return (((0, core_1.isNonEmptyString)(result, true) ? result : allowUseRecordId ? record.id : "") ??
+        (settings?.emptyReturnUndefined ? undefined : ""));
 };
 exports.getRecordDisplay = getRecordDisplay;
+/**
+ * Resolves the best short abstract/description text for a record.
+ *
+ * Resolution priority:
+ * 1. Search highlight (`highlight.searchContent[0]`)
+ * 2. `summary`, `description`, `abstract`
+ * 3. `searchContent` (only when `settings.includeContent` is true)
+ *
+ * Whitespace and punctuation are normalized before returning.
+ * Truncates to `settings.maxLength` characters when provided.
+ */
 const getRecordAbstract = (record, settings) => {
     if (!(0, core_1.isObject)(record))
         return "";
     let result = "";
-    if ((0, lodash_1.isArray)(record?.highlight?.searchContent) &&
-        record?.highlight?.searchContent?.length > 0) {
+    if ((0, lodash_1.isArray)(record?.highlight?.searchContent) && record?.highlight?.searchContent?.length > 0) {
         result = record.highlight.searchContent[0];
     }
     if (!(0, core_1.isNonEmptyString)(result) && (0, core_1.isNonEmptyString)(record.summary))
@@ -205,14 +246,16 @@ const getRecordAbstract = (record, settings) => {
         .replace(/;/g, "; ")
         .replace(new RegExp(`( ){2,}`, "g"), " ")
         .trim();
-    if (settings &&
-        (0, lodash_1.isNumber)(settings?.maxLength) &&
-        result.length > settings?.maxLength) {
+    if (settings && (0, lodash_1.isNumber)(settings?.maxLength) && result.length > settings?.maxLength) {
         result = `${result.substring(0, settings?.maxLength)} ...`;
     }
     return result;
 };
 exports.getRecordAbstract = getRecordAbstract;
+/**
+ * Returns the first non-empty string value found by iterating `contentFields` in order.
+ * Used internally by `getRecordContent` when an entity defines explicit content field names.
+ */
 const getRecordContentByContentFields = (record, contentFields) => {
     let result = "";
     if (contentFields && (0, lodash_1.isArray)(contentFields) && !(0, core_1.isNonEmptyString)(result)) {
@@ -223,6 +266,16 @@ const getRecordContentByContentFields = (record, contentFields) => {
     return result;
 };
 exports.getRecordContentByContentFields = getRecordContentByContentFields;
+/**
+ * Resolves the main body content for a record, suitable for indexing or display.
+ *
+ * Resolution priority:
+ * 1. Search highlight (`_ui.highlight.content`)
+ * 2. `searchContent` (when `includeSearchDisplay` is true)
+ * 3. Entity/settings `contentFields` (defaults to description, note, detail, content, …)
+ *
+ * Truncates to `maxLength` when provided.
+ */
 const getRecordContent = (record, settings) => {
     if (!(0, core_1.isObject)(record))
         return "";
@@ -251,14 +304,10 @@ const getRecordContent = (record, settings) => {
     if (includeSearchDisplay && !(0, core_1.isNonEmptyString)(result, true)) {
         result = record.searchContent;
     }
-    if (contentFields &&
-        (0, lodash_1.isArray)(contentFields) &&
-        !(0, core_1.isNonEmptyString)(result, true)) {
+    if (contentFields && (0, lodash_1.isArray)(contentFields) && !(0, core_1.isNonEmptyString)(result, true)) {
         result = (0, exports.getRecordContentByContentFields)(record, contentFields);
     }
-    if ((0, lodash_1.isNumber)(maxLength) &&
-        (0, core_1.isNonEmptyString)(result, true) &&
-        result.length > maxLength) {
+    if ((0, lodash_1.isNumber)(maxLength) && (0, core_1.isNonEmptyString)(result, true) && result.length > maxLength) {
         result = `${result.substring(0, maxLength)} ...`;
     }
     return (0, core_1.isNonEmptyString)(result, true)
@@ -268,37 +317,34 @@ const getRecordContent = (record, settings) => {
             : "";
 };
 exports.getRecordContent = getRecordContent;
+/**
+ * Formats a complete postal address from prefixed address fields on a record
+ * (e.g. `prefix = "billing"` reads `billingLine1`, `billingCity`, `billingState`, …).
+ * Returns `""` when the record does not contain the minimum required fields
+ * (city + state + country, or postalCode + country).
+ */
 const getRecordAddress = (record, prefix) => {
     if (!(0, core_1.isObject)(record))
         return "";
-    const line1 = (0, core_1.isNonEmptyString)(record[`${prefix}Line1`])
-        ? record[`${prefix}Line1`]
-        : "";
-    const line2 = (0, core_1.isNonEmptyString)(record[`${prefix}Line2`])
-        ? record[`${prefix}Line2`]
-        : "";
-    const city = (0, core_1.isNonEmptyString)(record[`${prefix}City`])
-        ? record[`${prefix}City`]
-        : "";
+    const line1 = (0, core_1.isNonEmptyString)(record[`${prefix}Line1`]) ? record[`${prefix}Line1`] : "";
+    const line2 = (0, core_1.isNonEmptyString)(record[`${prefix}Line2`]) ? record[`${prefix}Line2`] : "";
+    const city = (0, core_1.isNonEmptyString)(record[`${prefix}City`]) ? record[`${prefix}City`] : "";
     const postalCode = (0, core_1.isNonEmptyString)(record[`${prefix}PostalCode`])
         ? record[`${prefix}PostalCode`]
         : "";
-    const state = (0, core_1.isNonEmptyString)(record[`${prefix}State`])
-        ? record[`${prefix}State`]
-        : "";
-    const country = (0, core_1.isNonEmptyString)(record[`${prefix}Country`])
-        ? record[`${prefix}Country`]
-        : "";
-    if ((line1.length > 0 &&
-        city.length > 0 &&
-        state.length > 0 &&
-        country.length > 0) ||
+    const state = (0, core_1.isNonEmptyString)(record[`${prefix}State`]) ? record[`${prefix}State`] : "";
+    const country = (0, core_1.isNonEmptyString)(record[`${prefix}Country`]) ? record[`${prefix}Country`] : "";
+    if ((line1.length > 0 && city.length > 0 && state.length > 0 && country.length > 0) ||
         (postalCode.length > 0 && country.length > 0)) {
         return `${line1} ${line2},${city},${state},${postalCode},${country}`;
     }
     return "";
 };
 exports.getRecordAddress = getRecordAddress;
+/**
+ * Returns the primary media URL for a record, trying `media`, `photoUrl`, and
+ * `source.photoUrl` in that order. Returns `""` when none are set.
+ */
 const getRecordMedia = (record) => {
     if (!(0, core_1.isObject)(record))
         return "";
@@ -311,21 +357,23 @@ const getRecordMedia = (record) => {
     return "";
 };
 exports.getRecordMedia = getRecordMedia;
+/**
+ * Constructs a display name for a user-like record.
+ *
+ * Resolution order: `fullName` → `firstName + lastName` → `name` → `email`.
+ * `skipFullNameProp`, `skipNameProp`, `skipEmailProp` let callers exclude specific steps.
+ * Simplified Chinese locale (Windows locale code 2052) has spaces stripped from the assembled name.
+ * Multiple consecutive spaces are collapsed to a single space.
+ */
 const getRecordFullName = (user, settings) => {
     const { skipFullNameProp, skipNameProp, skipEmailProp } = settings ?? {};
     if (!(0, core_1.isObject)(user))
         return "";
     const email = (0, core_1.isNonEmptyString)(user.email) ? user.email.trim() : "";
     const name = (0, core_1.isNonEmptyString)(user.name) ? user.name.trim() : "";
-    let fullName = (0, core_1.isNonEmptyString)(user.fullName) && !skipFullNameProp
-        ? user.fullName.trim()
-        : "";
-    const firstName = (0, core_1.isNonEmptyString)(user.firstName)
-        ? user.firstName.trim()
-        : "";
-    const lastName = (0, core_1.isNonEmptyString)(user.lastName)
-        ? user.lastName.trim()
-        : "";
+    let fullName = (0, core_1.isNonEmptyString)(user.fullName) && !skipFullNameProp ? user.fullName.trim() : "";
+    const firstName = (0, core_1.isNonEmptyString)(user.firstName) ? user.firstName.trim() : "";
+    const lastName = (0, core_1.isNonEmptyString)(user.lastName) ? user.lastName.trim() : "";
     if (fullName.length == 0 ||
         (firstName.length > 0 && lastName.length > 0) ||
         (fullName.length > 0 && fullName == email)) {
@@ -341,6 +389,12 @@ const getRecordFullName = (user, settings) => {
     return fullName;
 };
 exports.getRecordFullName = getRecordFullName;
+/**
+ * Returns a formatted email address string for a record that has a valid `email` field.
+ * Format: `"Full Name <email@example.com>"`, or just `"email@example.com"` when
+ * `emailOnly` is true or no display name is available.
+ * Returns `undefined` when the record has no valid email.
+ */
 const getRecordEmailAddress = (record, emailOnly) => {
     if ((0, core_1.isObject)(record) && (0, core_1.isEmail)(record.email)) {
         const fullName = (0, exports.getRecordFullName)(record);
@@ -354,6 +408,12 @@ const getRecordEmailAddress = (record, emailOnly) => {
     return undefined;
 };
 exports.getRecordEmailAddress = getRecordEmailAddress;
+/**
+ * Builds an Open Graph / page metadata object for a record, suitable for `<head>` tags.
+ * Returns `{ id, title, description, type: "article", image? }`.
+ * Title is derived from `getRecordDisplay` (or `getRecordAbstract` when display is empty),
+ * optionally prefixed with `settings.siteName`.
+ */
 const getRecordPageMetadata = (record, settings) => {
     const result = {};
     const recordDisplay = (0, exports.getRecordDisplay)(record);
@@ -380,6 +440,11 @@ const getRecordPageMetadata = (record, settings) => {
     return result;
 };
 exports.getRecordPageMetadata = getRecordPageMetadata;
+/**
+ * Computes the current slug via `getRecordSlug` and ensures it is present in both
+ * `record.slug` (current) and `record.slugs` (historical list, deduplicated).
+ * Call this before persisting a record to keep slug history intact for redirects.
+ */
 const applyRecordSlug = (record) => {
     const curSlug = (0, exports.getRecordSlug)(record);
     if (curSlug) {
@@ -393,6 +458,13 @@ const applyRecordSlug = (record) => {
     return record;
 };
 exports.applyRecordSlug = applyRecordSlug;
+/**
+ * Derives a URL slug for a record.
+ * Uses `record.customSlug` when set; otherwise derives from `getRecordDisplay`.
+ * The slug is truncated to 128 characters and suffixed with the second GUID segment
+ * of the record ID (e.g. `"my-post-e29b"`) to guarantee global uniqueness.
+ * Returns `undefined` when the record has no `id`.
+ */
 const getRecordSlug = (record) => {
     if (!record.id)
         return undefined;
@@ -406,12 +478,23 @@ const getRecordSlug = (record) => {
     return curSlug;
 };
 exports.getRecordSlug = getRecordSlug;
+/**
+ * Builds the storage path for a file attached to a record.
+ * Format: `"{solutionId}/{organizationId}/{entityName}/{recordId}/{fieldName}"`.
+ * `fieldName` defaults to `"file"` when not provided.
+ */
 const getRecordFilePath = (props) => {
     const { solutionId, organizationId, recordId, entityName } = props;
     const fieldName = props.fieldName ?? "file";
     return `${solutionId}/${organizationId}/${entityName}/${recordId}/${fieldName}`;
 };
 exports.getRecordFilePath = getRecordFilePath;
+/**
+ * Extracts an `IContext` from a record that carries context fields directly
+ * (e.g. an API request body that has been enriched with caller context).
+ * Picks `solutionId`, `domain`, `sourceIp`, `userId`, `organizationId`,
+ * `user`, `organization`, and `solution`.
+ */
 const getContextFromRecord = (record) => {
     const { solutionId, domain, sourceIp, userId, organizationId, user, organization, solution } = record;
     return {
@@ -426,17 +509,30 @@ const getContextFromRecord = (record) => {
     };
 };
 exports.getContextFromRecord = getContextFromRecord;
+/**
+ * Returns true when a record is marked global but belongs to a different organization
+ * than the one in the current context. Used to identify marketplace/shared content.
+ */
 const fromOtherOrganization = (context, record) => {
-    return (record.isGlobal && record.organizationId != context.organizationId);
+    return record.isGlobal && record.organizationId != context.organizationId;
 };
 exports.fromOtherOrganization = fromOtherOrganization;
+/**
+ * Returns true when the record's ID appears in the current user's favorites list
+ * for the record's entity type (`context.user.favorites[entityName]`).
+ */
 const isFavorite = (context, record) => {
     const favorites = context.user?.favorites ? context.user?.favorites[record.entityName] : [];
     return favorites.includes(record.id);
 };
 exports.isFavorite = isFavorite;
+/**
+ * Returns true when a record is global and its owning organization differs from the
+ * current context's organization. Equivalent to `fromOtherOrganization` but compares
+ * against `context.organization.id` instead of `context.organizationId`.
+ */
 const isFromMarketplace = (context, record) => {
-    return (record.isGlobal && record.organizationId != context?.organization?.id);
+    return record.isGlobal && record.organizationId != context?.organization?.id;
 };
 exports.isFromMarketplace = isFromMarketplace;
 //# sourceMappingURL=record.js.map