@sassoftware/vi-api 0.0.29

package/http/index.d.ts

@@ -0,0 +1,364 @@
+export interface HttpResponse<R> {
+    body: R | null;
+    headers: Record<string, string | string[]>;
+    status: number;
+    statusText: string;
+    url: string | null;
+}
+/**
+ * This API provides functionality for making REST requests.
+ * Accessed from the window at window.sas.vi.http.
+ */
+export interface HttpApi {
+    /**
+     * @method
+     * @description Constructs a GET request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param [options] {HttpApi~StringRequestOptions} HTTP options to send with the request.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    get(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @description Constructs a GET request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @template R
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~JsonRequestOptions} HTTP options to send with the request.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    get<R>(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs a GET request that interprets the body as a Blob and returns the full HttpResponse.
+     * @template R
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~BlobRequestOptions} HTTP options to send with the request.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    get(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+    /**
+     * @method
+     * @description Constructs a HEAD request that returns a null body and the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~HeadOptions} HTTP options to send with the request.
+     * @return A Promise of the HttpResponse for the request with the response body of null.
+     */
+    head(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+    }): Promise<HttpResponse<null>>;
+    /**
+     * @method
+     * @description Constructs a POST request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~StringRequestOptions} HTTP options
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    post(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @template R
+     * @description Constructs a POST request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~JsonRequestOptions} HTTP options
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    post<R>(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs a POST request that interprets the body as a Blob and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~BlobRequestOptions} HTTP options
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    post(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+    /**
+     * @method
+     * @description Constructs a PUT request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~StringRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    put(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @template R
+     * @description Constructs a PUT request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~JsonRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    put<R>(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs a PUT request that interprets the body as a Blob and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~BlobRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    put(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+    /**
+     * @method
+     * @description Constructs a PATCH request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~StringRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    patch(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @template R
+     * @description Constructs a PATCH request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~JsonRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    patch<R>(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs a PATCH request that interprets the body as a Blob and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param body {(any|null)} Content to replace with current content.
+     * @param options {HttpApi~BlobRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    patch(url: string, body: any | null, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+    /**
+     * @method
+     * @description Constructs a DELETE request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~StringRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    delete(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @template R
+     * @description Constructs a DELETE request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~JsonRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    delete<R>(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs a DELETE request that interprets the body as a Blob and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~BlobRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    delete(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+    /**
+     * @method
+     * @description Constructs an OPTIONS request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~StringRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    options(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @template R
+     * @description Constructs an OPTIONS request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~JsonRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    options<R>(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs an OPTIONS request that interprets the body as a Blob and returns the full HttpResponse.
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~BlobRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    options(url: string, options?: {
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+    /**
+     * @method
+     * @description Constructs a request that interprets the body as a text stream and returns the full HttpResponse.
+     * @param method {string}
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~StringGenericRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a string.
+     */
+    request(method: string, url: string, options?: {
+        body?: any | null;
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "text";
+    }): Promise<HttpResponse<string>>;
+    /**
+     * @method
+     * @template R
+     * @description Constructs a request that interprets the body as a JSON object and returns the full HttpResponse.
+     * @param method {string}
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~JsonGenericRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is an object of type {@link R}.
+     */
+    request<R>(method: string, url: string, options?: {
+        body?: any | null;
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "json";
+    }): Promise<HttpResponse<R>>;
+    /**
+     * @method
+     * @description Constructs a request that interprets the body as a Blob and returns the full HttpResponse.
+     * @param method {string}
+     * @param url {string} Endpoint URL.
+     * @param options {HttpApi~BlobGenericRequestOptions} HTTP options.
+     * @return A Promise of the HttpResponse for the request.
+     * The response body is a Blob.
+     */
+    request(method: string, url: string, options?: {
+        body?: any | null;
+        headers?: Record<string, string | string[]>;
+        params?: Record<string, string | string[]>;
+        responseType: "blob";
+    }): Promise<HttpResponse<Blob>>;
+}
+/**
+ * @typedef {Object} HttpApi~StringRequestOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property responseType {"text"}
+ */
+/**
+ * @typedef {Object} HttpApi~JsonRequestOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property responseType {"json"}
+ */
+/**
+ * @typedef {Object} HttpApi~BlobRequestOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property responseType {"blob"}
+ */
+/**
+ * @typedef {Object} HttpApi~HeadOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ */
+/**
+ * @typedef {Object} HttpApi~StringGenericRequestOptions
+ * @property [body] {(any|null)}
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property [responseType] {"text"}
+ */
+/**
+ * @typedef {Object} HttpApi~JsonGenericRequestOptions
+ * @property [body] {(any|null)}
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property [responseType] {"json"}
+ */
+/**
+ * @typedef {Object} HttpApi~BlobGenericRequestOptions
+ * @property [body] {(any|null)}
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property [responseType] {"blob"}
+ */

package/http/index.js

@@ -0,0 +1,45 @@
+export {};
+/**
+ * @typedef {Object} HttpApi~StringRequestOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property responseType {"text"}
+ */
+/**
+ * @typedef {Object} HttpApi~JsonRequestOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property responseType {"json"}
+ */
+/**
+ * @typedef {Object} HttpApi~BlobRequestOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property responseType {"blob"}
+ */
+/**
+ * @typedef {Object} HttpApi~HeadOptions
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ */
+/**
+ * @typedef {Object} HttpApi~StringGenericRequestOptions
+ * @property [body] {(any|null)}
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property [responseType] {"text"}
+ */
+/**
+ * @typedef {Object} HttpApi~JsonGenericRequestOptions
+ * @property [body] {(any|null)}
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property [responseType] {"json"}
+ */
+/**
+ * @typedef {Object} HttpApi~BlobGenericRequestOptions
+ * @property [body] {(any|null)}
+ * @property [headers] {Record<string, string | string[]>}
+ * @property [params] {Record<string, string | string[]>}
+ * @property [responseType] {"blob"}
+ */

package/http/package.json

@@ -0,0 +1,9 @@
+{
+    "name": "@sassoftware/vi-api/http",
+    "files": [
+        "**/*.d.ts",
+        "**/*.js"
+    ],
+    "main": "public-api.js",
+    "types": "public-api.d.ts"
+}

package/http/public-api.d.ts

@@ -0,0 +1 @@
+export * from "./index";

package/http/public-api.js

@@ -0,0 +1 @@
+export * from "./index";

package/index.d.ts

@@ -0,0 +1,65 @@
+import { ComponentApi } from "./component";
+import { ConfigApi } from "./config/config-api";
+import { CurrentUserApi } from "./current-user/currentUser-api";
+import { EventApi } from "./event/event-api";
+import { FileApi } from "./file/file-api";
+import { HttpApi } from "./http";
+import { LocalizationApi } from "./localization/localization-api";
+import { AdminMetadataApi } from "./metadata/admin/admin-metadata-api";
+import { MetadataApi } from "./metadata/metadata-api";
+import { ObjectApi } from "./object/object-api";
+import { PageAdminApi } from "./page-admin/page-admin-api";
+import { PageModelApi } from "./page-model/page-model-api";
+import { PageStateApi } from "./page-state/page-state-api";
+import { PropertyApi } from "./property/property-api";
+import { RefDataApi } from "./reference-data/refData";
+import { ResourceApi } from "./resource/resource-api";
+import { ClientSearchApi } from "./search/client/client-search-api";
+import { SearchApi } from "./search/search-api";
+import { SheetApi } from "./sheet/sheet-api";
+import { TabApi } from "./tab/tab-api";
+import { ThemeApi } from "./theme/theme-api";
+import { TraversalApi } from "./traversal/traversal-api";
+/**
+ * Common API Functions
+ */
+export interface SviCommonApi {
+    component: ComponentApi;
+    currentUser: CurrentUserApi;
+    event: EventApi;
+    file: FileApi;
+    http: HttpApi;
+    localization: LocalizationApi;
+    metadata: MetadataApi;
+    pageAdmin: PageAdminApi;
+    pageModel: PageModelApi;
+    pageState: PageStateApi;
+    property: PropertyApi;
+    refData: RefDataApi;
+    resource: ResourceApi;
+    search: SearchApi;
+    theme: ThemeApi;
+    traversal: TraversalApi;
+    config: ConfigApi;
+}
+/**
+ * The Client API.
+ */
+export interface SviClientApi extends SviCommonApi {
+    object: ObjectApi;
+    search: ClientSearchApi;
+    sheet: SheetApi;
+    tab: TabApi;
+}
+/**
+ * The Admin API
+ */
+export interface SviAdminApi extends SviCommonApi {
+    metadata: AdminMetadataApi;
+}
+export declare type SviApi = SviClientApi | SviAdminApi;
+export declare type SviWindow = typeof window & {
+    sas: {
+        vi: SviApi;
+    };
+};

package/index.js

@@ -0,0 +1 @@
+export {};

package/localization/localization-api.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This API is used for the localization methods.
+ * Accessed from the window at window.sas.vi.localization.
+ */
+export interface LocalizationApi {
+    /**
+     * @method
+     * @description Returns the MomentJS format string based on locale.
+     * @param [showTime=true] {boolean} Checks whether or not to include time (in 12 hour format).
+     * @returns The localized date time format as a string.
+     */
+    getLocalizedDateTimeFormat(showTime?: boolean): string;
+    /**
+     * @method
+     * @description Gets the application locale in BCP 47 format.
+     * @returns The current application locale.
+     */
+    getLocale(): string;
+    /**
+     * @method
+     * @description Gets the application display direction.
+     * This is either "ltr" for left-to-right display locales, or "rtl" for right-to-left locales.
+     * @returns The current application display direction.
+     */
+    getDirection(): "ltr" | "rtl";
+}

package/localization/localization-api.js

@@ -0,0 +1 @@
+export {};

package/localization/package.json

@@ -0,0 +1,9 @@
+{
+    "name": "@sassoftware/vi-api/localization",
+    "files": [
+        "**/*.d.ts",
+        "**/*.js"
+    ],
+    "main": "public-api.js",
+    "types": "public-api.d.ts"
+}

package/localization/public-api.d.ts

@@ -0,0 +1 @@
+export * from "./localization-api";

package/localization/public-api.js

@@ -0,0 +1 @@
+export * from "./localization-api";

package/metadata/admin/admin-metadata-api.d.ts

@@ -0,0 +1,18 @@
+import { MetadataApi } from "../metadata-api";
+export interface FieldTypeLabels {
+    [type: string]: string;
+}
+/**
+ * {@link MetadataApi} extension provides the functionality related to retrieval of metadata.
+ * Additional methods are available only in the SAS Visual Investigator Admin Application.
+ * Accessed from the window at window.sas.vi.metadata.
+ * @extends MetadataApi
+ */
+export interface AdminMetadataApi extends MetadataApi {
+    /**
+     * @method
+     * @description Gets the field data type labels.
+     * @returns Object containing the field data type labels.
+     */
+    getFieldDataTypeLabels(): FieldTypeLabels;
+}

package/metadata/admin/admin-metadata-api.js

@@ -0,0 +1 @@
+export {};