@servicenow/glide 27.0.2 → 27.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@servicenow/glide",
-  "version": "27.0.2",
+  "version": "27.0.4",
   "description": "Contains type declaration for Glide Scriptable APIs",
   "homepage": "https://www.servicenow.com/docs/csh?topicname=servicenow-sdk-landing&version=latest",
   "keywords": [
@@ -11,13 +11,15 @@
   "license": "MIT",
   "scripts": {
     "prebuild": "tsx ./exports.ts",
+    "build": "tsc",
     "create-index": "ctix create -a ./src --noBackup --overwrite",
-    "test": "jest",
+    "test": "npm run build && jest",
     "ci": "npm ci"
   },
   "types": "./src/index.d.ts",
   "files": [
-    "src"
+    "src",
+    "!src/util/index.ts"
   ],
   "exports": {
     ".": "./src/types/index.js",

package/src/types/GlideAggregate.d.ts

@@ -1,4 +1,8 @@
 import { GlideQueryCondition } from "./GlideQueryCondition";
+import {
+  SafeTableField,
+  SafeTableFieldKey,
+} from "./_GlideRecordHelpers/SafeTableTypes";
 
 /**
  * The scoped GlideAggregate class is an extension of GlideRecord and allows database aggregation (COUNT, SUM, MIN, MAX,
@@ -7,33 +11,36 @@ import { GlideQueryCondition } from "./GlideQueryCondition";
  * GlideAggregate class on currency fields
  */
 
-export type GlideAggregate<T extends keyof Tables = never> = IGlideAggregate<T>;
+export type GlideAggregate<T extends keyof Tables | string = string> = IGlideAggregate<T>;
 export declare const GlideAggregate: IGlideAggregate;
 
-interface IGlideAggregate<T extends keyof Tables = never> {
+interface IGlideAggregate<T extends keyof Tables | string = string> {
   // Construction and table setup
-  new <T extends keyof Tables>(tableName: T): GlideAggregate<T>;
+  new <T extends keyof Tables | string>(tableName: T): GlideAggregate<T>;
 
   // ScopedGlideAggregate
   _next(): boolean;
-  _query<F extends keyof Tables[T]>(field: F, value: Tables[T][F]): void;
-  addNotNullQuery<F extends keyof Tables[T]>(
+  _query<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
+    field: F,
+    value: V
+  ): void;
+  addNotNullQuery<F extends SafeTableFieldKey<T & string>>(
     fieldName: F
   ): GlideQueryCondition<T>;
-  addNullQuery<F extends keyof Tables[T]>(fieldName: F): GlideQueryCondition<T>;
-  addQuery<F extends keyof Tables[T], V extends keyof Tables[T][F]>(
+  addNullQuery<F extends SafeTableFieldKey<T & string>>(fieldName: F): GlideQueryCondition<T>;
+  addQuery<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
   ): GlideQueryCondition<T>;
   addSystemEncodedQuery(query: string): void;
-  addSystemQuery<F extends keyof Tables[T], V extends keyof Tables[T][F]>(
+  addSystemQuery<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
   ): GlideQueryCondition<T>;
   addUserEncodedQuery(query: string): void;
-  addUserQuery<F extends keyof Tables[T], V extends keyof Tables[T][F]>(
+  addUserQuery<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
@@ -45,7 +52,11 @@ interface IGlideAggregate<T extends keyof Tables = never> {
    */
   next(): boolean;
   hasNext(): boolean;
-  query<F extends keyof Tables[T]>(field: F, value: Tables[T][F]): void;
+  query<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
+    field: F,
+    value: V
+  ): void;
+  query(): void;
 
   // GlideAggregate
 
@@ -53,11 +64,11 @@ interface IGlideAggregate<T extends keyof Tables = never> {
    * Adds an aggregate
    */
   addAggregate(agg: string, name: string): void;
-  addBizCalendarTrend<F extends keyof Tables[T]>(
+  addBizCalendarTrend<F extends SafeTableFieldKey<T & string>>(
     fieldName: F,
     bizCalendarSysId: string
   ): void;
-  addBizCalendarTrendBase<F extends keyof Tables[T]>(
+  addBizCalendarTrendBase<F extends SafeTableFieldKey<T & string>>(
     fieldName: F,
     bizCalendarSysId: string
   ): void;
@@ -72,23 +83,23 @@ interface IGlideAggregate<T extends keyof Tables = never> {
   addEncodedQuery(query: string, enforceFieldACLs: any): void;
   getEncodedQuery(): string;
   addHaving(arg1: string, arg2: string, arg3: string, arg4: string): void;
-  addSystemOrderBy<F extends keyof Tables[T]>(name: F): void;
+  addSystemOrderBy<F extends SafeTableFieldKey<T & string>>(name: F): void;
 
   /**
    * Sorts the aggregates into descending order based on the specified field
    */
-  addSystemOrderByDesc<F extends keyof Tables[T]>(name: F): void;
-  addTrend<F extends keyof Tables[T]>(
+  addSystemOrderByDesc<F extends SafeTableFieldKey<T & string>>(name: F): void;
+  addTrend<F extends SafeTableFieldKey<T & string>>(
     fieldName: F,
     timeInterval: string,
     numUnits: number
   ): void;
-  addUserOrderBy<F extends keyof Tables[T]>(name: F): void;
+  addUserOrderBy<F extends SafeTableFieldKey<T & string>>(name: F): void;
 
   /**
    * Sorts the aggregates into descending order based on the specified field
    */
-  addUserOrderByDesc<F extends keyof Tables[T]>(name: F): void;
+  addUserOrderByDesc<F extends SafeTableFieldKey<T & string>>(name: F): void;
   /**
    * Gets the value of the specified aggregate
    */
@@ -105,19 +116,19 @@ interface IGlideAggregate<T extends keyof Tables = never> {
   /**
    * Gets the value of a field
    */
-  getValue<F extends keyof Tables[T]>(name: F): string;
+  getValue<F extends SafeTableFieldKey<T & string>>(name: F): string;
 
   /**
    * Provides the name of a field to use in grouping the aggregates. May be called numerous times to set multiple
    * group fields
    */
-  groupBy<F extends keyof Tables[T]>(name: F): void;
+  groupBy<F extends SafeTableFieldKey<T & string>>(name: F): void;
   isBizCalendarTrendFillGap(): boolean;
 
   /**
    * Orders the aggregates using the value of the specified field. The field will also be added to the group-by list
    */
-  orderBy<F extends keyof Tables[T]>(name: F): void;
+  orderBy<F extends SafeTableFieldKey<T & string>>(name: F): void;
 
   /**
    * Sorts the aggregates based on the specified aggregate and field
@@ -127,7 +138,7 @@ interface IGlideAggregate<T extends keyof Tables = never> {
   /**
    * Sorts the aggregates into descending order based on the specified field
    */
-  orderByDesc<F extends keyof Tables[T]>(name: F): void;
+  orderByDesc<F extends SafeTableFieldKey<T & string>>(name: F): void;
   setAggregateWindow(firstRowWanted: number, lastRowWanted: number): void;
   setBizCalendarTrendFillGap(b: boolean): void;
 
@@ -156,7 +167,10 @@ interface IGlideAggregate<T extends keyof Tables = never> {
   enableSessionLanguageJoin(): void;
 
   // GlideRecord
-  _get<F extends keyof Tables[T]>(name: F, value: Tables[T][F]): boolean;
+  _get<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
+    name: F,
+    value: V
+  ): boolean;
   getTableName(): string;
   getRowCount(): number;
 }

package/src/types/GlideQuery.d.ts

@@ -170,7 +170,7 @@ interface UpdateMultipleResult {
  * @example
  * var query = new GlideQuery('sys_user');
  */
-export declare class GlideQuery<T extends keyof Tables = never> {
+export declare class GlideQuery<T extends keyof Tables | string = string> {
   /**
    * Creates a new GlideQuery instance
    * 

package/src/types/GlideQueryCondition.d.ts

@@ -1,9 +1,14 @@
+import {
+  SafeTableField,
+  SafeTableFieldKey,
+} from "./_GlideRecordHelpers/SafeTableTypes";
+
 /**
  * The scoped QueryCondition API provides additional AND or OR conditions that can be added to the current condition,
  * allowing you to build complex queries such as: category='hardware' OR category='software' AND priority='2' AND
  * priority='1'
  */
-export declare class GlideQueryCondition<T extends keyof Tables = never> {
+export declare class GlideQueryCondition<T extends keyof Tables | string = string> {
   constructor();
 
   /**
@@ -14,7 +19,7 @@ export declare class GlideQueryCondition<T extends keyof Tables = never> {
   /**
    * Adds an OR condition to the current condition.
    */
-  addOrCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addOrCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     value: V
   ): GlideQueryCondition<T>;
@@ -22,17 +27,17 @@ export declare class GlideQueryCondition<T extends keyof Tables = never> {
   /**
    * Adds an OR condition to the current condition.
    */
-  addOrCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addOrCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
   ): GlideQueryCondition<T>;
-  addSystemOrCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addSystemOrCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
   ): GlideQueryCondition<T>;
-  addUserOrCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addUserOrCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
@@ -46,7 +51,7 @@ export declare class GlideQueryCondition<T extends keyof Tables = never> {
   /**
    * Adds an AND condition to the current condition.
    */
-  addCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     value: V
   ): GlideQueryCondition<T>;
@@ -54,24 +59,24 @@ export declare class GlideQueryCondition<T extends keyof Tables = never> {
   /**
    * Adds an AND condition to the current condition.
    */
-  addCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     oper: string,
     value: V
   ): GlideQueryCondition<T>;
 
-  addCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
   ): GlideQueryCondition<T>;
-  addSystemCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addSystemCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V
   ): GlideQueryCondition<T>;
 
-  addUserCondition<F extends keyof Tables[T], V extends Tables[T][F]>(
+  addUserCondition<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
     name: F,
     operator: any,
     value: V

package/src/types/GlideRecord.d.ts

@@ -198,6 +198,7 @@ type IGlideRecord<T extends keyof Tables | string = string> = {
    * Insert a new record using the field values that have been set for the current record
    */
   insert(): string | null;
+  insertWithReferences(): string;
   /*
    * Runs the query against the table based on the specified filters by addQuery and addEncodedQuery
    */
@@ -205,6 +206,7 @@ type IGlideRecord<T extends keyof Tables | string = string> = {
     field: F,
     value: V
   ): void;
+  query(): void;
   /*
    * Defines a GlideRecord based on the specified expression of name = value
    */
@@ -216,8 +218,8 @@ type IGlideRecord<T extends keyof Tables | string = string> = {
   /*
    * Updates the current GlideRecord with any changes that have been made
    */
-  update(reason: any): string | null;
-  updateWithReferences(reason: any): string | null;
+  update(reason?: any): string | null;
+  updateWithReferences(reason?: any): string | null;
   /*
    * Updates each GlideRecord in the list with any changes that have been made
    */

package/src/types/GlideRecordSecure.d.ts

@@ -1,27 +1,22 @@
 import { GlideElement } from "./GlideElement";
 import { GlideRecord } from "./GlideRecord";
+import {
+  SafeTableFields,
+  SafeTableFieldKey,
+} from "./_GlideRecordHelpers/SafeTableTypes";
 
 /**
  * GlideRecordSecure is a class inherited from GlideRecord that performs the same functions as GlideRecord, and also
  * enforces ACLs
  */
 
-export type GlideRecordSecure<T extends keyof Tables = never> =
-  IGlideRecordSecure<T>;
+export type GlideRecordSecure<T extends keyof Tables | string = string> =
+  IGlideRecordSecure<T> & SafeTableFields<T>;
 export declare const GlideRecordSecure: IGlideRecordSecure;
 
-type IGlideRecordSecure<T extends keyof Tables = never> = {
-  [key in keyof Tables[T]]: GlideElement;
+type IGlideRecordSecure<T extends keyof Tables | string = string> = {
+  [key in SafeTableFieldKey<T & string>]: GlideElement<T>;
 } & {
   // Construction and table setup
-  new <T extends keyof Tables>(tableName: T): GlideRecordSecure<T>;
-  deleteMultiple(): void;
-  disableSecurityFeature(feature: string): void;
-  enableSecurityFeature(feature: string): void;
-  getElements(): GlideElement[];
-  getValue<F extends keyof Tables[T]>(name: F): string;
-  insertOrUpdate(keyField: string): string;
-  insertWithReferences(): string;
-  query<F extends keyof Tables[T]>(field: F, value: Tables[T][F]): void;
-  updateWithReferences(reason: any): string;
+  new <T extends keyof Tables | string>(tableName: T): GlideRecordSecure<T>;
 } & GlideRecord<T>;