powerpagestoolkit 1.0.0 → 1.0.11

package/index.d.ts

@@ -0,0 +1,71 @@
+declare module powerpagestoolkit {
+  interface DOMNodeReference {
+    constructor(querySelector: string);
+    element: HTMLElement | null;
+    isLoaded: boolean;
+
+    init(): Promise<this>;
+
+    hide(): void;
+    show(): void;
+    hideParent(): void;
+    showParent(): void;
+    hideContainer(): void;
+    showContainer(): void;
+    setValue(value: string): void;
+    getValue(): string;
+    append(...elements: HTMLElement[]): void;
+    after(...elements: HTMLElement[]): void;
+    getLabel(): HTMLElement;
+    appendToLabel(...elements: HTMLElement[]): void;
+    addClickListener(eventHandler: () => void): void;
+    addChangeListener(eventHandler: () => void): void;
+    uncheckRadios(): void;
+    createValidation(
+      evaluationFunction: (value: any) => boolean,
+      fieldDisplayName: string
+    ): void;
+    addLabelTooltip(text: string): void;
+    setTextContent(text: string): void;
+    onceLoaded(callback: (instance: this) => void): void;
+  }
+
+  export function createDOMNodeReference(
+    querySelector: string
+  ): Promise<DOMNodeReference>;
+
+  interface Schema {
+    logicalName(): string;
+    value(): any; // Adjust this type based on the structure of your schema values
+  }
+
+  export interface API {
+    /**
+     * Creates a new record in DataVerse.
+     * @param schema An instance of a schema class, containing the desired information for the POST request.
+     * @returns A Promise resolving the successful results (record ID) of the POST request, or rejecting with the error.
+     */
+    createRecord(schema: Schema): Promise<string>;
+
+    /**
+     * Retrieves a single record from DataVerse.
+     * @param tableSetName The DataVerse SET name of the table being queried.
+     * @param recordID The GUID of the record to be retrieved.
+     * @param selectColumns *OPTIONAL* Custom OData query for advanced GET results. Format: select=column1,column2,column3...
+     * @returns A Promise resolving the successful results of the GET request, or rejecting with the error.
+     */
+    getRecord(
+      tableSetName: string,
+      recordID: string,
+      selectColumns?: string
+    ): Promise<any>; // Adjust return type as necessary
+
+    /**
+     * Retrieves multiple records from DataVerse.
+     * @param tableSetName The DataVerse SET name of the table being queried.
+     * @param queryParameters *OPTIONAL* OData query parameters for refining search results: format = $filter=filters&$select=columns
+     * @returns A Promise resolving the successful results of the GET request, or rejecting with the error.
+     */
+    getMultiple(tableSetName: string, queryParameters?: string): Promise<any>; // Adjust return type as necessary
+  }
+}

package/index.js

@@ -1,4 +1,4 @@
-import API from "./package/API.js";
-import createDOMNodeReference from "./package/DOMNodeReferences.js";
+import API from "./lib/API.js";
+import createDOMNodeReference from "./lib/DOMNodeReferences.js";
 
 export { API, createDOMNodeReference };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerpagestoolkit",
-  "version": "1.0.0",
+  "version": "1.0.11",
   "description": "Reference, manipulate, and engage with Power Pages sites through the nodes in the DOM; use a variety of custom methods that allow customizing your power pages site quicker and easier.  ",
   "main": "index.js",
   "scripts": {
@@ -16,5 +16,9 @@
   },
   "author": "KeatonBrewster",
   "license": "SSPL-1.0",
-  "type": "module"
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Keaton-Brewster/PowerPagesToolKit"
+  }
 }