ssjs-data 0.2.2 → 0.3.1

package/dist/sfmc-globals.d.ts

@@ -0,0 +1,477 @@
+// sfmc-globals.d.ts — GENERATED by ssjs-data/scripts/generate-dts.mjs
+// DO NOT EDIT — run `npm run generate:dts` in ssjs-data to regenerate.
+// Ambient declarations for the complete SFMC SSJS global API surface.
+// Designed for use with TypeScript's noLib:true (no lib.es5.d.ts).
+
+// ── Platform ────────────────────────────────────────────────────────────────
+declare namespace Platform {
+    function Load(libraryName: string, version: string): void;
+    namespace Function {
+        function Lookup(deName: string, returnField: string, whereFieldNames: string | string[], whereFieldValues: string | any[]): string;
+        function LookupRows(deName: string, whereFieldNames: string | string[], whereFieldValues: string | any[]): object;
+        function LookupOrderedRows(deName: string, count: number, orderBy: string, whereFieldNames: string | string[], whereFieldValues: string | any[]): object;
+        function InsertData(deName: string, fieldNames: string[], fieldValues: any[]): number;
+        function InsertDE(deName: string, fieldNames: string[], fieldValues: any[]): void;
+        function UpdateData(deName: string, whereFieldNames: string | string[], whereFieldValues: string | any[], fieldNames: string[], fieldValues: any[]): number;
+        function UpdateDE(deName: string, whereFieldNames: string | string[], whereFieldValues: string | any[], fieldNames: string[], fieldValues: any[]): number;
+        function UpsertData(deName: string, whereFieldNames: string | string[], whereFieldValues: string | any[], fieldNames: string[], fieldValues: any[]): number;
+        function UpsertDE(deName: string, whereFieldNames: string | string[], whereFieldValues: string | any[], fieldNames: string[], fieldValues: any[]): number;
+        function DeleteData(deName: string, whereFieldNames: string[], whereFieldValues: any[]): number;
+        function DeleteDE(deName: string, whereFieldNames: string[], whereFieldValues: any[]): number;
+        function ContentBlockByKey(customerKey: string, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
+        function ContentBlockByName(name: string, regionName?: string, stopOnError?: boolean, fallbackContent?: string, statusVariable?: number): string;
+        function ContentBlockByID(id: number, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
+        function ContentImageByKey(key: string, fallbackId?: number): string;
+        function ContentImageByID(id: number, fallbackId?: number): string;
+        function TreatAsContent(content: string): string;
+        function BeginImpressionRegion(name: string): void;
+        function EndImpressionRegion(closeAll?: boolean): void;
+        function Now(useContextTime?: boolean): string;
+        function SystemDateToLocalDate(dateValue: string): string;
+        function LocalDateToSystemDate(dateValue: string): string;
+        function RaiseError(message: string, currentRecipientOnly?: boolean, errorCode?: string, errorNumber?: number): void;
+        function GUID(): string;
+        function IsEmailAddress(value: string): boolean;
+        function IsPhoneNumber(value: string): boolean;
+        function CreateObject(objectType: string): object;
+        function SetObjectProperty(apiObject: object, propertyName: string, value: any): void;
+        function AddObjectArrayItem(apiObject: object, propertyName: string, value: any): void;
+        function InvokeCreate(apiObject: object, status: any[], options: object): object;
+        function InvokeUpdate(apiObject: object, status: any[], options: object): object;
+        function InvokeDelete(apiObject: object, status: any[], options: object): object;
+        function InvokeRetrieve(apiObject: object, status: any[]): object;
+        function InvokePerform(apiObject: object, method: string, status: any[], options: object): object;
+        function InvokeConfigure(apiObject: object, method: string, status: any[], options: object): object;
+        function InvokeExecute(apiObject: object, status: any[], options: object): object;
+        function InvokeExtract(apiObject: object, statusArray: any[], options?: object): string;
+        function InvokeSchedule(apiObject: object, action: string, schedule: object, statusArray?: any[], options?: object): string;
+        function HTTPGet(url: string, continueOnError: boolean, emptyContentHandling?: number, headerNames?: string[], headerValues?: string[], statusVariable?: number[]): string;
+        function HTTPPost(url: string, contentType: string, payload: string, headerNames?: string[], headerValues?: string[], response?: any[]): number;
+        function ParseJSON(jsonString: string | string[]): object | object[];
+        function RedirectTo(url: string): void;
+        function UrlEncode(url: string, encodeReservedKeywords?: boolean): string;
+        function Base64Encode(string: string, charset?: string): string;
+        function Base64Decode(encodedString: string, charset?: string): string;
+        function MD5(string: string, charset?: string): string;
+        function Stringify(object: object): string;
+        function ContentArea(id: number, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
+        function ContentAreaByName(name: string, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
+        function IsCHTMLBrowser(userAgentString: string): boolean;
+    }
+    namespace Variable {
+        function GetValue(variableName: string): string;
+        function SetValue(variableName: string, value: string): void;
+    }
+    namespace Response {
+        function SetResponseHeader(headerName: string, value: string): void;
+        function RemoveResponseHeader(headerName: string): void;
+        function Redirect(url: string, movedPermanently: boolean): void;
+        function SetCookie(name: string, value: string, expires?: string, secure?: boolean): void;
+        function RemoveCookie(name: string): void;
+        function Write(content: string): void;
+        var ContentType: string;
+        var CharacterSet: string;
+    }
+    namespace Request {
+        function GetQueryStringParameter(parameterName: string): string;
+        function GetFormField(name: string): string;
+        function GetPostData(encoding?: string): string;
+        function GetCookieValue(cookieName: string): string;
+        function GetUserLanguages(): string;
+        function GetRequestHeader(headerName: string): string;
+        const Browser: object;
+        const ClientIP: string;
+        const HasSSL: boolean;
+        const IsSSL: boolean;
+        const Method: string;
+        const QueryString: string;
+        const ReferrerURL: string;
+        const RequestURL: string;
+        const UserAgent: string;
+    }
+    namespace Recipient {
+        function GetAttributeValue(attributeName: string): string;
+    }
+}
+
+// ── Bare-name globals (aliasOf Platform.*) ──────────────────────────────────
+declare function ContentArea(id: number, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
+declare function ContentAreaByName(name: string, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
+declare function BeginImpressionRegion(name: string): void;
+declare function EndImpressionRegion(closeAll?: boolean): void;
+declare function Now(useContextTime?: boolean): string;
+declare function SystemDateToLocalDate(dateValue: string): string;
+declare function LocalDateToSystemDate(dateValue: string): string;
+declare function Redirect(url: string, movedPermanently: boolean): void;
+declare function GUID(): string;
+declare function IsEmailAddress(value: string): boolean;
+declare function IsPhoneNumber(value: string): boolean;
+declare function Write(content: string): void;
+declare function Stringify(object: object): string;
+
+// ── DataExtension instance interfaces ───────────────────────────────────────
+interface DataExtensionFieldsAccessor {
+    Add(properties: object): string;
+    Retrieve(): object[];
+    UpdateSendableField(deFieldName: string, subscriberField: string): string;
+}
+interface DataExtensionRowsAccessor {
+    Add(rowData: any[]): string;
+    Lookup(searchFieldNames: any[], searchValues: any[], limit?: number, orderByFieldName?: string): object[];
+    Remove(columnNames: any[], columnValues: any[]): number;
+    Retrieve(filter?: object): object[];
+    Update(rowData: object, whereFieldNames: any[], whereValues: any[]): string;
+}
+interface DataExtensionInstance {
+    Fields: DataExtensionFieldsAccessor;
+    Rows: DataExtensionRowsAccessor;
+}
+
+// ── Core Library namespaces ──────────────────────────────────────────────────
+declare namespace Account {
+    function Init(key: string): any;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+}
+declare namespace Account.Tracking {
+    function Retrieve(filter: object): object[];
+}
+declare namespace AccountUser {
+    function Init(targetUserKey: string, myClientID: number): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Activate(): string;
+    function Deactivate(): string;
+}
+declare namespace Portfolio {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+}
+declare namespace ContentAreaObj {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+}
+declare namespace Folder {
+    function Init(key?: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+    function SetID(id: number): void;
+}
+declare namespace Template {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+}
+declare namespace DeliveryProfile {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Update(properties: object): string;
+    function Remove(): string;
+}
+declare namespace SenderProfile {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Update(properties: object): string;
+    function Remove(): string;
+}
+declare namespace SendClassification {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+}
+declare namespace FilterDefinition {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+}
+declare namespace QueryDefinition {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+    function Perform(action: string): string;
+}
+declare namespace List {
+    function Init(key: string): any;
+    function Add(properties: object): any;
+    function Retrieve(filter: object): object[];
+    function Remove(): string;
+}
+declare namespace List.Subscribers {
+    function Add(properties: object): string;
+    function Retrieve(filter?: object): object[];
+    function Unsubscribe(emailAddress: string): string;
+    function Update(emailAddress: string, status: string): string;
+    function Upsert(emailAddress: string, attributes: object): string;
+}
+declare namespace List.Subscribers.Tracking {
+    function Retrieve(filter: object): object[];
+}
+declare namespace Subscriber {
+    function Init(key: string): any;
+    function Add(properties: object): string;
+    function Retrieve(filter: object): object[];
+    function Upsert(properties: object): string;
+    function Statistics(subscriberKey: string): object;
+    function Update(properties: object): string;
+    function Remove(): string;
+    function Unsubscribe(): string;
+}
+declare namespace Subscriber.Attributes {
+    function Retrieve(): object[];
+}
+declare namespace Subscriber.Lists {
+    function Retrieve(): object[];
+}
+declare namespace Email {
+    function Init(key: string): any;
+    function Add(properties: object): any;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+    function Validate(): object;
+    function CheckContent(): object;
+}
+declare namespace Send {
+    function Init(id: number): any;
+    function Add(emailKey: string, listIds: any[], options?: object): string;
+    function Retrieve(filter: object): object[];
+    function RetrieveLists(filter: object): object[];
+    function Remove(): string;
+    function CancelSend(): string;
+}
+declare namespace Send.Tracking {
+    function Retrieve(filter: object): object[];
+    function ClickRetrieve(filter: object): object[];
+    function TotalByIntervalRetrieve(type: string, startDate: string, endDate: string, groupBy: string): object[];
+}
+declare namespace Send.Definition {
+    function Init(key: string): any;
+    function Add(esdParams: object, sendClassificationKey: string, emailKey: string, listIds: any[]): string;
+    function AddWithDE(esdParams: object, sendClassificationKey: string, emailKey: string, sendableDataExtensionKey: string, publicationListKey: string): string;
+    function AddWithFilterDefinition(esdParams: object, sendClassificationKey: string, emailKey: string, filterDefinitionKey: string, listId: number): string;
+    function Retrieve(filter?: object): object[];
+    function Update(properties: object): string;
+    function Remove(): string;
+    function Send(): string;
+}
+declare namespace TriggeredSend {
+    function Init(key: string): any;
+    function Add(properties: object): any;
+    function Retrieve(filter: object): object[];
+    function Update(properties: object): string;
+    function Start(): string;
+    function Pause(): string;
+    function Publish(): string;
+    function Send(emailAddress: string, sendTimeAttributes?: object): string;
+}
+declare namespace TriggeredSend.Tracking {
+    function Retrieve(filter?: object): object[];
+}
+declare namespace TriggeredSend.Tracking.Clicks {
+    function Retrieve(filter: object): object[];
+}
+declare namespace TriggeredSend.Tracking.TotalByInterval {
+    function Retrieve(type: string, startDate: string, endDate: string, groupBy: string): object[];
+}
+declare namespace DataExtension {
+    function Init(key: string): DataExtensionInstance;
+    function Add(properties: object): DataExtensionInstance;
+    function Retrieve(filter: object, queryAllAccounts?: boolean): object[];
+}
+declare namespace DataExtension.Fields {
+    function Add(properties: object): string;
+    function Retrieve(): object[];
+    function UpdateSendableField(deFieldName: string, subscriberField: string): string;
+}
+declare namespace DataExtension.Rows {
+    function Add(rowData: any[]): string;
+    function Lookup(searchFieldNames: any[], searchValues: any[], limit?: number, orderByFieldName?: string): object[];
+    function Remove(columnNames: any[], columnValues: any[]): number;
+    function Retrieve(filter?: object): object[];
+    function Update(rowData: object, whereFieldNames: any[], whereValues: any[]): string;
+}
+declare namespace DateTime.TimeZone {
+    function Retrieve(filter: object): object[];
+}
+
+// ── Standalone Core Library globals ──────────────────────────────────────────
+declare namespace Attribute {
+    function GetValue(name: string): string;
+}
+
+declare namespace ErrorUtil {
+    function ThrowWSProxyError(result: object): void;
+}
+
+// ── Event namespaces ─────────────────────────────────────────────────────────
+declare namespace BounceEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace ClickEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace ForwardedEmailEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace ForwardedEmailOptInEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace NotSentEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace OpenEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace SentEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace SurveyEvent {
+    function Retrieve(filter: object): object[];
+}
+declare namespace UnsubEvent {
+    function Retrieve(filter: object): object[];
+}
+
+// ── HTTP / HTTPHeader ────────────────────────────────────────────────────────
+declare namespace HTTP {
+    function Get(url: string, headerNames?: any[], headerValues?: any[]): object;
+    function Post(url: string, contentType: string, payload: string, headerNames: string[], headerValues: any[]): object;
+}
+
+declare namespace HTTPHeader {
+    function GetValue(name: string): string;
+    function SetValue(name: string, value: string): void;
+    function Remove(headerName: string): string;
+}
+
+// ── Script.Util ──────────────────────────────────────────────────────────────
+declare namespace Script {
+    namespace Util {
+        class WSProxy {
+            constructor();
+            createItem(objectType: string, properties: object): object;
+            updateItem(objectType: string, properties: object): object;
+            deleteItem(objectType: string, properties: object): object;
+            retrieve(objectType: string, columns: any[], filter?: object, retrieveOptions?: object, requestProps?: object): object;
+            getNextBatch(objectType: string, requestId: string): object;
+            performItem(objectType: string, properties: object, action: string, performOptions?: object): object;
+            performBatch(objectType: string, propertiesArray: any[], action: string, performOptions?: object): object;
+            describe(objectType: string): object;
+            execute(objectType: string, requestName: string): object;
+            setBatchSize(batchSize: number): void;
+            setClientId(clientId: object): void;
+            resetClientIds(): void;
+            createBatch(objectType: string, propertiesArray: any[]): object;
+            updateBatch(objectType: string, propertiesArray: any[]): object;
+            deleteBatch(objectType: string, propertiesArray: any[]): object;
+        }
+        class HttpRequest {
+            constructor(url: string);
+            send(): object;
+            setHeader(name: string, value: string): void;
+            clearHeaders(): void;
+            removeHeader(name: string): void;
+        }
+        class HttpGet {
+            constructor(url: string);
+            send(): object;
+            setHeader(name: string, value: string): void;
+            clearHeaders(): void;
+            removeHeader(name: string): void;
+        }
+    }
+}
+
+// ── ECMAScript built-ins (SFMC-supported subset only) ───────────────────────
+interface Array<T> {
+    join(separator?: string): string;
+    push(...elements: T[]): number;
+    pop(): T;
+    shift(): T;
+    unshift(...elements: T[]): number;
+    concat(...values: T[]): T[];
+    slice(start?: number, end?: number): T[];
+    sort(compareFn?: any): T[];
+    reverse(): T[];
+    splice(start: number, deleteCount?: number, ...items: T[]): T[];
+    readonly length: number;
+}
+
+interface String {
+    charAt(index?: number): string;
+    charCodeAt(index?: number): number;
+    indexOf(searchValue?: string, fromIndex?: number): number;
+    lastIndexOf(searchValue?: string, fromIndex?: number): number;
+    match(regexp?: RegExp): any[];
+    replace(searchValue?: any, replaceValue?: string): string;
+    search(regexp?: RegExp): number;
+    slice(start?: number, end?: number): string;
+    split(separator?: any, limit?: number): any[];
+    substring(start?: number, end?: number): string;
+    toLowerCase(): string;
+    toUpperCase(): string;
+    concat(...strings: string[]): string;
+    substr(start?: number, length?: number): string;
+    readonly length: number;
+}
+
+interface Number {
+    toFixed(fractionDigits?: number): string;
+    toExponential(fractionDigits?: number): string;
+    toPrecision(precision?: number): string;
+}
+
+interface Object {
+    hasOwnProperty(v?: string): boolean;
+}
+
+declare namespace Math {
+    function abs(x?: number): number;
+    function ceil(x?: number): number;
+    function floor(x?: number): number;
+    function max(...values: number[]): number;
+    function min(...values: number[]): number;
+    function pow(base?: number, exponent?: number): number;
+    function random(): number;
+    function round(x?: number): number;
+    function sqrt(x?: number): number;
+    function sin(x?: number): number;
+    function cos(x?: number): number;
+    function tan(x?: number): number;
+    function asin(x?: number): number;
+    function acos(x?: number): number;
+    function atan(x?: number): number;
+    function atan2(y?: number, x?: number): number;
+    function exp(x?: number): number;
+    function log(x?: number): number;
+    const PI: number;
+    const E: number;
+    const LN2: number;
+    const LN10: number;
+    const LOG2E: number;
+    const LOG10E: number;
+    const SQRT2: number;
+    const SQRT1_2: number;
+}
+
+// Global ECMAScript functions
+declare function parseInt(string?: string, radix?: number): number;
+declare function parseFloat(string?: string): number;
+declare function isNaN(value?: any): boolean;
+declare function isFinite(value?: any): boolean;

package/package.json

@@ -1,14 +1,16 @@
 {
     "name": "ssjs-data",
-    "version": "0.2.2",
+    "version": "0.3.1",
     "description": "Canonical SSJS (Server-Side JavaScript) function catalog, Core library objects, Platform methods, and globals for SFMC tooling",
     "type": "module",
     "main": "src/index.js",
     "exports": {
-        ".": "./src/index.js"
+        ".": "./src/index.js",
+        "./sfmc-globals.d.ts": "./dist/sfmc-globals.d.ts"
     },
     "files": [
-        "src"
+        "src",
+        "dist"
     ],
     "repository": {
         "type": "git",
@@ -30,9 +32,26 @@
     ],
     "license": "MIT",
     "scripts": {
-        "test": "echo No tests defined"
+        "test": "echo No tests defined",
+        "generate:dts": "node scripts/generate-dts.mjs",
+        "lint": "eslint .",
+        "lint:fix": "eslint --fix .",
+        "prepare": "husky || true",
+        "format": "prettier --write .",
+        "format:check": "prettier --check ."
     },
     "engines": {
         "node": ">=18.0.0"
+    },
+    "devDependencies": {
+        "@eslint/js": "^10.0.1",
+        "eslint": "^10.1.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-jsdoc": "^62.0.0",
+        "eslint-plugin-prettier": "^5.5.0",
+        "eslint-plugin-unicorn": "^64.0.0",
+        "globals": "^17.4.0",
+        "husky": "^9.1.7",
+        "prettier": "^3.8.1"
     }
 }