tm1npm 1.0.0

package/lib/objects/Application.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkApplication = exports.FolderApplication = exports.DocumentApplication = exports.SubsetApplication = exports.ViewApplication = exports.ChoreApplication = exports.ProcessApplication = exports.DimensionApplication = exports.CubeApplication = exports.Application = exports.ApplicationTypeAliases = exports.ApplicationTypes = void 0;
+const TM1Object_1 = require("./TM1Object");
+var ApplicationTypes;
+(function (ApplicationTypes) {
+    ApplicationTypes["CUBE"] = "tm1.cube";
+    ApplicationTypes["DIMENSION"] = "tm1.dimension";
+    ApplicationTypes["PROCESS"] = "tm1.process";
+    ApplicationTypes["CHORE"] = "tm1.chore";
+    ApplicationTypes["VIEW"] = "tm1.view";
+    ApplicationTypes["SUBSET"] = "tm1.subset";
+    ApplicationTypes["DOCUMENT"] = "tm1.document";
+    ApplicationTypes["FOLDER"] = "tm1.folder";
+    ApplicationTypes["LINK"] = "tm1.link";
+})(ApplicationTypes || (exports.ApplicationTypes = ApplicationTypes = {}));
+// Compatibility aliases
+exports.ApplicationTypeAliases = {
+    Cube: ApplicationTypes.CUBE,
+    Dimension: ApplicationTypes.DIMENSION,
+    Process: ApplicationTypes.PROCESS,
+    Chore: ApplicationTypes.CHORE,
+    View: ApplicationTypes.VIEW,
+    Subset: ApplicationTypes.SUBSET,
+    Document: ApplicationTypes.DOCUMENT,
+    Folder: ApplicationTypes.FOLDER,
+    Link: ApplicationTypes.LINK
+};
+class Application extends TM1Object_1.TM1Object {
+    constructor(name, path = '', documented = false, type = 'Application') {
+        super();
+        this._name = name;
+        this._path = path;
+        this._documented = documented;
+        this._type = type;
+    }
+    get name() {
+        return this._name;
+    }
+    set name(name) {
+        this._name = name;
+    }
+    get path() {
+        return this._path;
+    }
+    set path(path) {
+        this._path = path;
+    }
+    get documented() {
+        return this._documented;
+    }
+    set documented(documented) {
+        this._documented = documented;
+    }
+    get type() {
+        return this._type;
+    }
+    get body() {
+        return JSON.stringify({
+            Name: this._name,
+            Path: this._path,
+            Documented: this._documented,
+            Type: this._type
+        });
+    }
+    static fromDict(applicationAsDict) {
+        return new Application(applicationAsDict.Name, applicationAsDict.Path || '', applicationAsDict.Documented || false, applicationAsDict.Type || 'Application');
+    }
+}
+exports.Application = Application;
+class CubeApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.CUBE);
+    }
+}
+exports.CubeApplication = CubeApplication;
+class DimensionApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.DIMENSION);
+    }
+}
+exports.DimensionApplication = DimensionApplication;
+class ProcessApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.PROCESS);
+    }
+}
+exports.ProcessApplication = ProcessApplication;
+class ChoreApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.CHORE);
+    }
+}
+exports.ChoreApplication = ChoreApplication;
+class ViewApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.VIEW);
+    }
+}
+exports.ViewApplication = ViewApplication;
+class SubsetApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.SUBSET);
+    }
+}
+exports.SubsetApplication = SubsetApplication;
+class DocumentApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, true, ApplicationTypes.DOCUMENT);
+    }
+}
+exports.DocumentApplication = DocumentApplication;
+class FolderApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.FOLDER);
+    }
+}
+exports.FolderApplication = FolderApplication;
+class LinkApplication extends Application {
+    constructor(name, path = '') {
+        super(name, path, false, ApplicationTypes.LINK);
+    }
+}
+exports.LinkApplication = LinkApplication;
+//# sourceMappingURL=Application.js.map

package/lib/objects/Axis.d.ts

@@ -0,0 +1,36 @@
+import { TM1Object } from './TM1Object';
+import { Subset, AnonymousSubset } from './Subset';
+export declare class ViewAxisSelection extends TM1Object {
+    /** Describes what is selected in a dimension on an axis. Can be a Registered Subset or an Anonymous Subset
+     */
+    private _subset;
+    private _dimensionName;
+    private _hierarchyName;
+    constructor(dimensionName: string, subset: Subset | AnonymousSubset);
+    get subset(): Subset | AnonymousSubset;
+    get dimensionName(): string;
+    get hierarchyName(): string;
+    get body(): string;
+    get bodyAsDict(): Record<string, any>;
+    static fromDict(data: Record<string, any>): ViewAxisSelection;
+    private constructBody;
+}
+export declare class ViewTitleSelection {
+    /** Describes what is selected in a dimension on the view title.
+     *    Can be a Registered Subset or an Anonymous Subset
+     */
+    private _dimensionName;
+    private _hierarchyName;
+    private _subset;
+    private _selected;
+    constructor(dimensionName: string, subset: AnonymousSubset | Subset, selected: string);
+    get subset(): Subset | AnonymousSubset;
+    get dimensionName(): string;
+    get hierarchyName(): string;
+    get selected(): string;
+    get body(): string;
+    get bodyAsDict(): Record<string, any>;
+    static fromDict(data: Record<string, any>): ViewTitleSelection;
+    private constructBody;
+}
+//# sourceMappingURL=Axis.d.ts.map

package/lib/objects/Axis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Axis.d.ts","sourceRoot":"","sources":["../../src/objects/Axis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAGnD,qBAAa,iBAAkB,SAAQ,SAAS;IAC5C;OACG;IAEH,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,cAAc,CAAS;gBAEnB,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,eAAe;IAYnE,IAAW,MAAM,IAAI,MAAM,GAAG,eAAe,CAE5C;IAED,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAE3C;WAEa,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,iBAAiB;IAKpE,OAAO,CAAC,aAAa;CAqBxB;AAGD,qBAAa,kBAAkB;IAC3B;;OAEG;IAEH,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,SAAS,CAAS;gBAEd,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM;IAOrF,IAAW,MAAM,IAAI,MAAM,GAAG,eAAe,CAE5C;IAED,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAE3C;WAEa,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB;IAKrE,OAAO,CAAC,aAAa;CA6BxB"}

package/lib/objects/Axis.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewTitleSelection = exports.ViewAxisSelection = void 0;
+const TM1Object_1 = require("./TM1Object");
+const Subset_1 = require("./Subset");
+const Utils_1 = require("../utils/Utils");
+class ViewAxisSelection extends TM1Object_1.TM1Object {
+    constructor(dimensionName, subset) {
+        /**
+         *    :Parameters:
+         *        `dimension_name` : String
+         *        `subset` : Subset or AnonymousSubset
+         */
+        super();
+        this._subset = subset;
+        this._dimensionName = dimensionName;
+        this._hierarchyName = dimensionName;
+    }
+    get subset() {
+        return this._subset;
+    }
+    get dimensionName() {
+        return this._dimensionName;
+    }
+    get hierarchyName() {
+        return this._hierarchyName;
+    }
+    get body() {
+        return JSON.stringify(this.constructBody());
+    }
+    get bodyAsDict() {
+        return this.constructBody();
+    }
+    static fromDict(data) {
+        // Basic implementation - would need actual data structure
+        return new ViewAxisSelection('', new Subset_1.AnonymousSubset('', ''));
+    }
+    constructBody() {
+        /** construct the ODATA conform JSON represenation for the ViewAxisSelection entity.
+         *
+         * :return: dictionary
+         */
+        const bodyAsDict = {};
+        if (this._subset instanceof Subset_1.AnonymousSubset) {
+            bodyAsDict['Subset'] = JSON.parse(this._subset.body);
+        }
+        else if (this._subset instanceof Subset_1.Subset) {
+            const subsetPath = (0, Utils_1.formatUrl)("Dimensions('{}')/Hierarchies('{}')/Subsets('{}')", this._dimensionName, this._hierarchyName, this._subset.name);
+            bodyAsDict['Subset@odata.bind'] = subsetPath;
+        }
+        return bodyAsDict;
+    }
+}
+exports.ViewAxisSelection = ViewAxisSelection;
+class ViewTitleSelection {
+    constructor(dimensionName, subset, selected) {
+        this._dimensionName = dimensionName;
+        this._hierarchyName = dimensionName;
+        this._subset = subset;
+        this._selected = selected;
+    }
+    get subset() {
+        return this._subset;
+    }
+    get dimensionName() {
+        return this._dimensionName;
+    }
+    get hierarchyName() {
+        return this._hierarchyName;
+    }
+    get selected() {
+        return this._selected;
+    }
+    get body() {
+        return JSON.stringify(this.constructBody());
+    }
+    get bodyAsDict() {
+        return this.constructBody();
+    }
+    static fromDict(data) {
+        // Basic implementation - would need actual data structure
+        return new ViewTitleSelection('', new Subset_1.AnonymousSubset('', ''), '');
+    }
+    constructBody() {
+        /** construct the ODATA conform JSON represenation for the ViewTitleSelection entity.
+         *
+         * :return: string, the valid JSON
+         */
+        const bodyAsDict = {};
+        if (this._subset instanceof Subset_1.AnonymousSubset) {
+            bodyAsDict['Subset'] = JSON.parse(this._subset.body);
+        }
+        else if (this._subset instanceof Subset_1.Subset) {
+            const subsetPath = (0, Utils_1.formatUrl)("Dimensions('{}')/Hierarchies('{}')/Subsets('{}')", this._dimensionName, this._hierarchyName, this._subset.name);
+            bodyAsDict['Subset@odata.bind'] = subsetPath;
+        }
+        const elementPath = (0, Utils_1.formatUrl)("Dimensions('{}')/Hierarchies('{}')/Elements('{}')", this._dimensionName, this._hierarchyName, this._selected);
+        bodyAsDict['Selected@odata.bind'] = elementPath;
+        return bodyAsDict;
+    }
+}
+exports.ViewTitleSelection = ViewTitleSelection;
+//# sourceMappingURL=Axis.js.map

package/lib/objects/Chore.d.ts

@@ -0,0 +1,43 @@
+import { TM1Object } from './TM1Object';
+import { ChoreFrequency } from './ChoreFrequency';
+import { ChoreStartTime } from './ChoreStartTime';
+import { ChoreTask } from './ChoreTask';
+export declare class Chore extends TM1Object {
+    /** Abstraction of TM1 Chore
+     *
+     */
+    static readonly SINGLE_COMMIT = "SingleCommit";
+    static readonly MULTIPLE_COMMIT = "MultipleCommit";
+    private _name;
+    private _startTime;
+    private _dstSensitivity;
+    private _active;
+    private _executionMode;
+    private _frequency;
+    private _tasks;
+    constructor(name: string, startTime: ChoreStartTime, dstSensitivity: boolean, active: boolean, executionMode: string, frequency: ChoreFrequency, tasks: Iterable<ChoreTask>);
+    static fromJSON(choreAsJson: string): Chore;
+    static fromDict(choreAsDict: any): Chore;
+    get name(): string;
+    set name(name: string);
+    get startTime(): ChoreStartTime;
+    set startTime(startTime: ChoreStartTime);
+    get dstSensitivity(): boolean;
+    set dstSensitivity(dstSensitivity: boolean);
+    get active(): boolean;
+    get executionMode(): string;
+    set executionMode(executionMode: string);
+    get frequency(): ChoreFrequency;
+    set frequency(frequency: ChoreFrequency);
+    get tasks(): ChoreTask[];
+    set tasks(tasks: ChoreTask[]);
+    addTask(task: ChoreTask): void;
+    removeTask(step: number): ChoreTask | undefined;
+    get body(): string;
+    get bodyAsDict(): any;
+    private constructBody;
+    reschedule(frequency: ChoreFrequency, startTime?: ChoreStartTime): void;
+    activate(): void;
+    deactivate(): void;
+}
+//# sourceMappingURL=Chore.d.ts.map

package/lib/objects/Chore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Chore.d.ts","sourceRoot":"","sources":["../../src/objects/Chore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,qBAAa,KAAM,SAAQ,SAAS;IAChC;;OAEG;IACH,gBAAuB,aAAa,kBAAkB;IACtD,gBAAuB,eAAe,oBAAoB;IAE1D,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,MAAM,CAAc;gBAGxB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,cAAc,EACzB,cAAc,EAAE,OAAO,EACvB,MAAM,EAAE,OAAO,EACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,cAAc,EACzB,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC;WAYhB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK;WAUpC,QAAQ,CAAC,WAAW,EAAE,GAAG,GAAG,KAAK;IAkB/C,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,IAAI,CAAC,IAAI,EAAE,MAAM,EAE3B;IAED,IAAW,SAAS,IAAI,cAAc,CAErC;IAED,IAAW,SAAS,CAAC,SAAS,EAAE,cAAc,EAE7C;IAED,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,IAAW,cAAc,CAAC,cAAc,EAAE,OAAO,EAEhD;IAED,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED,IAAW,aAAa,CAAC,aAAa,EAAE,MAAM,EAE7C;IAED,IAAW,SAAS,IAAI,cAAc,CAErC;IAED,IAAW,SAAS,CAAC,SAAS,EAAE,cAAc,EAE7C;IAED,IAAW,KAAK,IAAI,SAAS,EAAE,CAE9B;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,EAElC;IAEM,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAI9B,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAOtD,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,UAAU,IAAI,GAAG,CAE3B;IAED,OAAO,CAAC,aAAa;IAYd,UAAU,CAAC,SAAS,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,cAAc,GAAG,IAAI;IAYvE,QAAQ,IAAI,IAAI;IAMhB,UAAU,IAAI,IAAI;CAK5B"}

package/lib/objects/Chore.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chore = void 0;
+const TM1Object_1 = require("./TM1Object");
+const ChoreFrequency_1 = require("./ChoreFrequency");
+const ChoreStartTime_1 = require("./ChoreStartTime");
+const ChoreTask_1 = require("./ChoreTask");
+class Chore extends TM1Object_1.TM1Object {
+    constructor(name, startTime, dstSensitivity, active, executionMode, frequency, tasks) {
+        super();
+        this._name = name;
+        this._startTime = startTime;
+        this._dstSensitivity = dstSensitivity;
+        this._active = active;
+        this._executionMode = executionMode;
+        this._frequency = frequency;
+        this._tasks = Array.from(tasks);
+    }
+    static fromJSON(choreAsJson) {
+        /** Alternative constructor
+         *
+         * :param chore_as_json: string, JSON. Response of /Chores('x')/Tasks?$expand=*
+         * :return: Chore, an instance of this class
+         */
+        const choreAsDict = JSON.parse(choreAsJson);
+        return Chore.fromDict(choreAsDict);
+    }
+    static fromDict(choreAsDict) {
+        /** Alternative constructor
+         *
+         * :param chore_as_dict: Chore as dict
+         * :return: Chore, an instance of this class
+         */
+        return new Chore(choreAsDict.Name, ChoreStartTime_1.ChoreStartTime.fromString(choreAsDict.StartTime), choreAsDict.DSTSensitive, choreAsDict.Active, choreAsDict.ExecutionMode, ChoreFrequency_1.ChoreFrequency.fromString(choreAsDict.Frequency), choreAsDict.Tasks.map((task, step) => ChoreTask_1.ChoreTask.fromDict(task, step)));
+    }
+    get name() {
+        return this._name;
+    }
+    set name(name) {
+        this._name = name;
+    }
+    get startTime() {
+        return this._startTime;
+    }
+    set startTime(startTime) {
+        this._startTime = startTime;
+    }
+    get dstSensitivity() {
+        return this._dstSensitivity;
+    }
+    set dstSensitivity(dstSensitivity) {
+        this._dstSensitivity = dstSensitivity;
+    }
+    get active() {
+        return this._active;
+    }
+    get executionMode() {
+        return this._executionMode;
+    }
+    set executionMode(executionMode) {
+        this._executionMode = executionMode;
+    }
+    get frequency() {
+        return this._frequency;
+    }
+    set frequency(frequency) {
+        this._frequency = frequency;
+    }
+    get tasks() {
+        return this._tasks;
+    }
+    set tasks(tasks) {
+        this._tasks = tasks;
+    }
+    addTask(task) {
+        this._tasks.push(task);
+    }
+    removeTask(step) {
+        if (step >= 0 && step < this._tasks.length) {
+            return this._tasks.splice(step, 1)[0];
+        }
+        return undefined;
+    }
+    get body() {
+        return JSON.stringify(this.constructBody());
+    }
+    get bodyAsDict() {
+        return this.constructBody();
+    }
+    constructBody() {
+        const body = {};
+        body.Name = this._name;
+        body.StartTime = this._startTime.toString();
+        body.DSTSensitive = this._dstSensitivity;
+        body.Active = this._active;
+        body.ExecutionMode = this._executionMode;
+        body.Frequency = this._frequency.toString();
+        body.Tasks = this._tasks.map(task => task.bodyAsDict);
+        return body;
+    }
+    reschedule(frequency, startTime) {
+        /** Reschedule the chore
+         *
+         * :param frequency: new ChoreFrequency
+         * :param start_time: new ChoreStartTime (optional)
+         */
+        this._frequency = frequency;
+        if (startTime) {
+            this._startTime = startTime;
+        }
+    }
+    activate() {
+        /** Activate the chore
+         */
+        this._active = true;
+    }
+    deactivate() {
+        /** Deactivate the chore
+         */
+        this._active = false;
+    }
+}
+exports.Chore = Chore;
+/** Abstraction of TM1 Chore
+ *
+ */
+Chore.SINGLE_COMMIT = 'SingleCommit';
+Chore.MULTIPLE_COMMIT = 'MultipleCommit';
+//# sourceMappingURL=Chore.js.map

package/lib/objects/ChoreFrequency.d.ts

@@ -0,0 +1,23 @@
+import { TM1Object } from './TM1Object';
+export declare class ChoreFrequency extends TM1Object {
+    /** Utility class to handle time representation fore Chore Frequency
+     */
+    private _days;
+    private _hours;
+    private _minutes;
+    private _seconds;
+    constructor(days: string | number, hours: string | number, minutes: string | number, seconds: string | number);
+    get days(): string;
+    get hours(): string;
+    get minutes(): string;
+    get seconds(): string;
+    set days(value: string | number);
+    set hours(value: string | number);
+    set minutes(value: string | number);
+    set seconds(value: string | number);
+    static fromString(frequencyString: string): ChoreFrequency;
+    get frequencyString(): string;
+    get body(): string;
+    toString(): string;
+}
+//# sourceMappingURL=ChoreFrequency.d.ts.map

package/lib/objects/ChoreFrequency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChoreFrequency.d.ts","sourceRoot":"","sources":["../../src/objects/ChoreFrequency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,qBAAa,cAAe,SAAQ,SAAS;IACzC;OACG;IAEH,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAS;gBAEb,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAQ7G,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAErC;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAEtC;IAED,IAAW,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAExC;IAED,IAAW,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAExC;WAEa,UAAU,CAAC,eAAe,EAAE,MAAM,GAAG,cAAc;IAcjE,IAAW,eAAe,IAAI,MAAM,CAEnC;IAED,IAAW,IAAI,IAAI,MAAM,CAQxB;IAEM,QAAQ,IAAI,MAAM;CAG5B"}

package/lib/objects/ChoreFrequency.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChoreFrequency = void 0;
+const TM1Object_1 = require("./TM1Object");
+class ChoreFrequency extends TM1Object_1.TM1Object {
+    constructor(days, hours, minutes, seconds) {
+        super();
+        this._days = String(days).padStart(2, '0');
+        this._hours = String(hours).padStart(2, '0');
+        this._minutes = String(minutes).padStart(2, '0');
+        this._seconds = String(seconds).padStart(2, '0');
+    }
+    get days() {
+        return this._days;
+    }
+    get hours() {
+        return this._hours;
+    }
+    get minutes() {
+        return this._minutes;
+    }
+    get seconds() {
+        return this._seconds;
+    }
+    set days(value) {
+        this._days = String(value).padStart(2, '0');
+    }
+    set hours(value) {
+        this._hours = String(value).padStart(2, '0');
+    }
+    set minutes(value) {
+        this._minutes = String(value).padStart(2, '0');
+    }
+    set seconds(value) {
+        this._seconds = String(value).padStart(2, '0');
+    }
+    static fromString(frequencyString) {
+        const posDt = frequencyString.indexOf('DT', 1);
+        const posH = frequencyString.indexOf('H', posDt);
+        const posM = frequencyString.indexOf('M', posH);
+        const posS = frequencyString.length - 1;
+        return new ChoreFrequency(frequencyString.substring(1, posDt), frequencyString.substring(posDt + 2, posH), frequencyString.substring(posH + 1, posM), frequencyString.substring(posM + 1, posS));
+    }
+    get frequencyString() {
+        return `P${this._days}DT${this._hours}H${this._minutes}M${this._seconds}S`;
+    }
+    get body() {
+        return JSON.stringify({
+            Days: this._days,
+            Hours: this._hours,
+            Minutes: this._minutes,
+            Seconds: this._seconds,
+            FrequencyString: this.frequencyString
+        });
+    }
+    toString() {
+        return this.frequencyString;
+    }
+}
+exports.ChoreFrequency = ChoreFrequency;
+//# sourceMappingURL=ChoreFrequency.js.map

package/lib/objects/ChoreStartTime.d.ts

@@ -0,0 +1,15 @@
+export declare class ChoreStartTime {
+    /** Utility class to handle time representation for Chore Start Time
+     */
+    private _datetime;
+    tz?: string;
+    constructor(year: number, month: number, day: number, hour: number, minute: number, second: number, tz?: string);
+    static fromString(startTimeString: string): ChoreStartTime;
+    get startTimeString(): string;
+    get datetime(): Date;
+    toString(): string;
+    setTime(year?: number, month?: number, day?: number, hour?: number, minute?: number, second?: number): void;
+    add(days?: number, hours?: number, minutes?: number, seconds?: number): void;
+    subtract(days?: number, hours?: number, minutes?: number, seconds?: number): void;
+}
+//# sourceMappingURL=ChoreStartTime.d.ts.map

package/lib/objects/ChoreStartTime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChoreStartTime.d.ts","sourceRoot":"","sources":["../../src/objects/ChoreStartTime.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAc;IACvB;OACG;IAEH,OAAO,CAAC,SAAS,CAAO;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEP,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM;WAajG,UAAU,CAAC,eAAe,EAAE,MAAM,GAAG,cAAc;IA6BjE,IAAW,eAAe,IAAI,MAAM,CAkBnC;IAED,IAAW,QAAQ,IAAI,IAAI,CAE1B;IAEM,QAAQ,IAAI,MAAM;IAIlB,OAAO,CACV,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,EACd,GAAG,CAAC,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GAChB,IAAI;IAWA,GAAG,CAAC,IAAI,GAAE,MAAU,EAAE,KAAK,GAAE,MAAU,EAAE,OAAO,GAAE,MAAU,EAAE,OAAO,GAAE,MAAU,GAAG,IAAI;IAQxF,QAAQ,CAAC,IAAI,GAAE,MAAU,EAAE,KAAK,GAAE,MAAU,EAAE,OAAO,GAAE,MAAU,EAAE,OAAO,GAAE,MAAU,GAAG,IAAI;CAOvG"}

package/lib/objects/ChoreStartTime.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChoreStartTime = void 0;
+class ChoreStartTime {
+    constructor(year, month, day, hour, minute, second, tz) {
+        /**
+         * :param year: year
+         * :param month: month
+         * :param day: day
+         * :param hour: hour or None
+         * :param minute: minute or None
+         * :param second: second or None
+         */
+        this._datetime = new Date(year, month - 1, day, hour, minute, second); // month is 0-indexed in JS
+        this.tz = tz;
+    }
+    static fromString(startTimeString) {
+        // extract optional tz info (e.g., +01:00) from string end
+        let tz;
+        if (startTimeString.includes('+')) {
+            // case "2020-11-05T08:00:01+01:00",
+            tz = "+" + startTimeString.split('+')[1];
+        }
+        else if (startTimeString.split('-').length === 4) {
+            // case: "2020-11-05T08:00:01-01:00",
+            const parts = startTimeString.split('-');
+            tz = "-" + parts[parts.length - 1];
+        }
+        else {
+            tz = undefined;
+        }
+        // f to handle strange timestamp 2016-09-25T20:25Z instead of common 2016-09-25T20:25:00Z
+        // second is defaulted to 0 if not specified in the chore schedule
+        const f = (x) => x ? parseInt(x) : 0;
+        return new ChoreStartTime(f(startTimeString.substring(0, 4)), f(startTimeString.substring(5, 7)), f(startTimeString.substring(8, 10)), f(startTimeString.substring(11, 13)), f(startTimeString.substring(14, 16)), startTimeString[16] !== ":" ? 0 : f(startTimeString.substring(17, 19)), tz);
+    }
+    get startTimeString() {
+        // produce timestamp 2016-09-25T20:25:00Z instead of common 2016-09-25T20:25Z where no seconds are specified
+        const year = this._datetime.getFullYear().toString().padStart(4, '0');
+        const month = (this._datetime.getMonth() + 1).toString().padStart(2, '0');
+        const day = this._datetime.getDate().toString().padStart(2, '0');
+        const hour = this._datetime.getHours().toString().padStart(2, '0');
+        const minute = this._datetime.getMinutes().toString().padStart(2, '0');
+        const second = this._datetime.getSeconds().toString().padStart(2, '0');
+        let startTime = `${year}-${month}-${day}T${hour}:${minute}:${second}`;
+        if (this.tz) {
+            startTime += this.tz;
+        }
+        else {
+            startTime += "Z";
+        }
+        return startTime;
+    }
+    get datetime() {
+        return this._datetime;
+    }
+    toString() {
+        return this.startTimeString;
+    }
+    setTime(year, month, day, hour, minute, second) {
+        const _year = year !== undefined ? year : this._datetime.getFullYear();
+        const _month = month !== undefined ? month - 1 : this._datetime.getMonth(); // month is 0-indexed
+        const _day = day !== undefined ? day : this._datetime.getDate();
+        const _hour = hour !== undefined ? hour : this._datetime.getHours();
+        const _minute = minute !== undefined ? minute : this._datetime.getMinutes();
+        const _second = second !== undefined ? second : this._datetime.getSeconds();
+        this._datetime = new Date(_year, _month, _day, _hour, _minute, _second);
+    }
+    add(days = 0, hours = 0, minutes = 0, seconds = 0) {
+        const totalMs = days * 24 * 60 * 60 * 1000 +
+            hours * 60 * 60 * 1000 +
+            minutes * 60 * 1000 +
+            seconds * 1000;
+        this._datetime = new Date(this._datetime.getTime() + totalMs);
+    }
+    subtract(days = 0, hours = 0, minutes = 0, seconds = 0) {
+        const totalMs = days * 24 * 60 * 60 * 1000 +
+            hours * 60 * 60 * 1000 +
+            minutes * 60 * 1000 +
+            seconds * 1000;
+        this._datetime = new Date(this._datetime.getTime() - totalMs);
+    }
+}
+exports.ChoreStartTime = ChoreStartTime;
+//# sourceMappingURL=ChoreStartTime.js.map

package/lib/objects/ChoreTask.d.ts

@@ -0,0 +1,28 @@
+import { TM1Object } from './TM1Object';
+export interface ChoreTaskParameter {
+    Name: string;
+    Value: string;
+}
+export declare class ChoreTask extends TM1Object {
+    /** Abstraction of a Chore Task
+     *
+     *    A Chore task always conistst of
+     *    - The step integer ID: it's order in the execution plan.
+     *      1 to n, where n is the last Process in the Chore
+     *    - The name of the process to execute
+     *    - The parameters for the process
+     */
+    private _step;
+    private _processName;
+    private _parameters;
+    constructor(step: number, processName: string, parameters: ChoreTaskParameter[]);
+    static fromDict(choreTaskAsDict: Record<string, any>, step?: number): ChoreTask;
+    get bodyAsDict(): Record<string, any>;
+    get step(): number;
+    get processName(): string;
+    get parameters(): ChoreTaskParameter[];
+    get body(): string;
+    equals(other: ChoreTask): boolean;
+    notEquals(other: ChoreTask): boolean;
+}
+//# sourceMappingURL=ChoreTask.d.ts.map

package/lib/objects/ChoreTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChoreTask.d.ts","sourceRoot":"","sources":["../../src/objects/ChoreTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,SAAU,SAAQ,SAAS;IACpC;;;;;;;OAOG;IAEH,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,WAAW,CAAuB;gBAE9B,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE;WAkBjE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS;IAmBtF,IAAW,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAK3C;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,UAAU,IAAI,kBAAkB,EAAE,CAE5C;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAEM,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAKjC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAI9C"}