@twintag/twintag-sdk 0.2.235-TTPL-1970-twintagsdk-397570c85978488f2e5cebf3cab22c0a2faa6217

package/lib/types/libs/twintag-sdk/src/lib/view.d.ts

@@ -0,0 +1,368 @@
+import { Client } from './client';
+import { Project } from './project';
+import { FileInfo } from './files';
+import { VirtualFile } from './virtual';
+import { ListObject } from './listObject';
+import { OfflineOptions } from '@twintag/model';
+import { ViewInit } from './base';
+/**
+ * CreateBag creates a free bag without an association to an Enterprise project.
+ */
+export declare function createBag(qid?: string): Promise<View>;
+/**
+ * CreateBagInternal is the internal createBag function.
+ *
+ * @internal */
+export declare function createBagInternal(client: Client, project?: Project, qid?: string): Promise<View>;
+/**
+ * The view class allows you to interact with a view into a bag.
+ * A view is represented by a `qid`. This is the string you see in its url:
+ * `https://twintag.io/<qid>`.
+ * A bag can have multiple views, each view can have different rights associated.
+ * For example: owner, download-only, upload-only, ...
+ *
+ * To construct a view object, you pass its QID, E.g.:
+ * ```
+ * let view = new Twintag.View(viewId)
+ * ```
+ */
+export declare class View {
+    private _base;
+    private _epsilon;
+    /**
+     * Construct a view by its QID.
+     *
+     * @param init Internal parameter.
+     */
+    constructor(qid: string);
+    get qid(): string;
+    set qid(val: string);
+    get _client(): Client;
+    set _client(val: Client);
+    get _data(): ViewObject;
+    set _data(val: ViewObject);
+    get project(): Project;
+    set project(val: Project);
+    useCaching(val: boolean): void;
+    /**
+     * _setConfig allows us to pass internal state.
+     *
+     * @internal */
+    _setConfig(init: ViewInit): void;
+    /**
+     * Set the token used for authorization. This can be used to authorize
+     * requests by the project API key rather than the view QID. However,
+     * It is recommended use the {@link Project} object instead.
+     */
+    setToken(token: string): void;
+    private fileURL;
+    private fileURLUpload;
+    /**
+     * Data gets the view definition. This includes the view rights.
+     */
+    data(): Promise<ViewObject>;
+    /**
+     * Upload allows you to upload a file into a bag.
+     *
+     * Required rights: upload.
+     *
+     * @param name Optionally overwrite the file name.
+     * @param parent: parent of the file. FileQid of the folder
+     *
+     * @category File management
+     */
+    upload(f: File, name?: string, parent?: string): Promise<FileInfo>;
+    /**
+     * Upload a {@VirtualFile | virtual file} into a bag.
+     *
+     * Required rights: owner.
+     *
+     * @category File management
+     */
+    uploadVirtual(f: VirtualFile, name: string): Promise<void>;
+    /**
+     * Download a file from a bag.
+     *
+     * Required rights: download.
+     *
+     * @category File management
+     */
+    download(name: string): Promise<ReadableStream>;
+    /**
+     * Convenience method to download a JSON file from a bag and parse it.
+     *
+     * Required rights: download.
+     *
+     * @category File management
+     */
+    downloadJSON<T>(name: string): Promise<T>;
+    /**
+     * Rename a file from a bag.
+     *
+     * Required rights: upload & download.
+     *
+     * @category File management
+     */
+    rename(source: FileInfo, name: string): Promise<FileInfo>;
+    /**
+     * Move a file.
+     *
+     * Required rights: upload & download, plus owner rights when specifying a bag.
+     *
+     * @category File management
+     */
+    move(source: FileInfo, name?: string, parent?: string, view?: string): Promise<FileInfo>;
+    /**
+     * Copy a file.
+     *
+     * Required rights: upload & download, plus owner rights when specifying a bag.
+     *
+     * @category File management
+     */
+    copy(source: FileInfo, name?: string, parent?: string, view?: string): Promise<FileInfo>;
+    private doMove;
+    /**
+     * Delete a file from a bag.
+     *
+     * Required rights: delete.
+     *
+     * @category File management
+     */
+    delete(file: FileInfo): Promise<void>;
+    /**
+     * Delete an entire bag.
+     *
+     * Required rights: owner.
+     */
+    deleteBag(): Promise<void>;
+    /**
+     * Get a view with limited rights.
+     *
+     * Required rights: owner.
+     */
+    getUserView(rights: string[]): Promise<View>;
+    /**
+     * List the files in the bag or a sub-folder.
+     *
+     * Required rights: list.
+     *
+     * @category File management
+     */
+    list(folder?: string): Promise<FileInfo[]>;
+    /**
+     * This method creates a folder for a twintag.
+     * @param folderName
+     * @param folderParent
+     * @returns
+     */
+    addFolder<T>(folderName: string, folderParent?: string): Promise<T>;
+    /**
+     * Seal the bag.
+     *
+     * Required rights: list.
+     *
+     * @hidden
+     */
+    seal(): Promise<void>;
+    /**
+     * Get the bag metadata of this specific bag. The metadata is returned as an object.
+     *
+     * Required rights: download.
+     *
+     * @param lang: optional language value. Allowed inputs are "all" or any language defined in project languages. If no value is passed, then project's default language will be used for returning data
+     * @category Metadata
+     */
+    getMetadata<T>(lang?: string): Promise<T>;
+    /**
+     * Set the bag metadata of this specific bag. Returns a full view of the resulting metadata.
+     *
+     * Required rights: owner.
+     *
+     * @param data An object representing the metadata.
+     *
+     * @category Metadata
+     */
+    setMetadata<T>(data: T): Promise<T>;
+    /**
+     * Get the bag data of a specific bag and object. The data is returned as an object.
+     *
+     * Required rights: download.
+     *
+     * @param objectAPIName The apiName of the object for which the data is being requested
+     *
+     * @param attribute Optional parameter to specify the attribute for which the data is required
+     *
+     * @category Structured Data
+     */
+    getData<T>(objectAPIName: string, attribute?: string): Promise<T>;
+    /**
+     * Set the bag data of this specific bag and object. Returns a full view of the resulting data.
+     *
+     * Required rights: owner.
+     *
+     * @param data An object representing the data.
+     * @param objectApiName APIName of the object for which the data is being set.
+     *
+     * @category Structured Data
+     */
+    setData<T>(objectApiName: string, data: T): Promise<T>;
+    /**
+     * Get an object for the view
+     *
+     * Required rights: owner.
+     *
+     * @param objectApiName APIName of the object
+     *
+     * @category Structured Data
+     */
+    object(objectApiName: string): Promise<ListObject>;
+    /**
+     * Sends notification to the registered users of the view.
+     *
+     * Required rights: owner.
+     *
+     * @param message message to be sent as a notification.
+     * @param channel optional, if not specified then default channel is 'email'
+     *
+     * Example:
+     * ```js
+     * await viewObj.notify(`This is a custom email body.`)
+     * ```
+     *
+     * You can further customize email body by passing {@link NotificationRequest}:
+     * ```js
+     * await viewObj.notify({
+     *    message: "custom user message"
+     *    subject: "custom email subject"
+     *    bagAlias: "Custom alias for bag"
+     *    showBagReport: true
+     *    language: "en-GB"
+     * })
+     * ```
+     * You can provide any ISO 15897 locale for language attribute.
+     * Currently supported values: en_GB, nl_BE, fr_BE
+     * @category Notification
+     */
+    notify<T>(request: string | NotificationRequest, channel?: string): Promise<T>;
+    /**
+   * Sends email to the registered users of the view.
+   *
+   * @param request message to be sent.
+   *
+   * Example:
+   * ```js
+   * await viewObj.sendFeedback({content: 'This is test content'})
+   * ```
+   *
+   * You can further customize email body by passing {@link FeedbackRequest}:
+   * ```js
+   * await viewObj.sendFeedback({
+   *    content: 'This is test content',
+   *    subject: "custom email subject",
+   *    email: 'email';
+   * })
+   * ```
+   * @category Notification
+   */
+    sendFeedback<T>(request: string | FeedbackRequest): Promise<T>;
+    /**
+     * Sends email
+     *
+     * Required rights: Any.
+     *
+     * @param request EmailRequest object
+     *
+     * Example:
+     *
+     * You can call this method by passing {@link EmailRequest}:
+     * ```js
+     * await viewObj.sendToSubscribers({
+     *    recepients: ["to@mail.com"]
+     *    body: "email body"
+     *    subject: "email subject"
+     *    cc: ["cc@mail.com"]
+     *    bcc: ["bcc@mail.com"]
+     * })
+     * ```
+     * @category Notifications
+     */
+    sendToSubscribers<T>(request: EmailRequest): Promise<T>;
+    /**
+    * Execute an epsilon.
+    *
+    * Required rights: any.
+    *
+    * @param filename name of epsilon file.
+    * @param requestOptions object
+    * @param action (optional) title/name of request for offline support
+    *
+    * @category Structured Data
+    */
+    executeEpsilon<T>(filename: string, requestOptions: any, offlineOptions?: OfflineOptions): Promise<T>;
+}
+/**
+ * Notification request message.
+ */
+interface NotificationRequest {
+    message: string;
+    subject?: string;
+    bagAlias?: string;
+    showBagReport?: boolean;
+    language?: string;
+}
+/**
+ * Notification request message.
+ */
+export interface EmailRequest {
+    sender?: string;
+    recipients?: string[];
+    body?: string;
+    subject?: string;
+    cc?: string[];
+    bcc?: string[];
+    toSubscribers?: boolean;
+    mergeVars?: {};
+    /**
+     * template used for mailchimp templates. This will override the default template in admin settings.
+     */
+    template?: string;
+}
+/**
+ * FeedbackRequest message.
+ */
+interface FeedbackRequest {
+    email?: string;
+    subject?: string;
+    content: string;
+    rating?: number;
+}
+/**
+ * View information data
+ */
+interface ViewObjectData {
+    rights: string[];
+    project: ProjectData;
+}
+/**
+ * Project information data
+ */
+interface ProjectData {
+    projectId: string;
+    projectName: string;
+    companyName: string;
+}
+/**
+ * View information
+ */
+export interface ViewObject {
+    id: string;
+    type: string;
+    bagQid: string;
+    data: ViewObjectData;
+    uploadsession: string;
+    state: string;
+    wsToken: string;
+    wsSeed: string;
+    authToken: string;
+}
+export {};

package/lib/types/libs/twintag-sdk/src/lib/virtual.d.ts

@@ -0,0 +1,92 @@
+/**
+ * A virtual file is a file that doesn't have static content like a normal file.
+ * Instead, the content of the file is materialized upon request.
+ *
+ * To create a virtual file you first construct one of the VirtualFile sub-classes.
+ * Next, you upload them using {@link View.uploadVirtual}. E.g.:
+ * ```js
+ * let virtual = new Twintag.Link("https://example.com")
+ * await view.uploadVirtual(virtual, "My link")
+ * ```
+ */
+export declare abstract class VirtualFile {
+    /**
+     * Get the virtual file mode.
+     *
+     * @internal
+     */
+    readonly mode: number;
+    /**
+     * Construct a virtual file.
+     *
+     * @internal
+     * */
+    constructor(mode: number);
+    /**
+     * Get the virtual file definition.
+     *
+     * @internal
+     */
+    abstract GetDefinition(): Definition;
+}
+/**
+ * A link is a virtual file that represents a web link.
+ *
+ * First construct the link, next upload it to a bag using {@link View.uploadVirtual}. E.g.:
+ * ```js
+ * let virtual = new Twintag.Link("https://example.com")
+ * await view.uploadVirtual(virtual, "My link")
+ * ```
+ */
+export declare class Link extends VirtualFile {
+    /**
+     *
+     * The link URL.
+     */
+    readonly url: string;
+    /**
+     *
+     * The link target.
+     */
+    readonly target: string;
+    /**
+     *
+     * Construct a web link by URL.
+     *
+     * @param target The default target is "_blank ". Other targets may be restricted.
+     */
+    constructor(url: string, target?: string);
+    /**
+     * Get the virtual file definition.
+     *
+     * @internal
+     */
+    GetDefinition(): Definition;
+}
+/**
+ * Link virtual file data.
+ *
+ * @internal
+ */
+export interface LinkData {
+    url: string;
+    target: string;
+}
+/**
+ * Virtual file definition data.
+ *
+ * @internal
+ */
+export interface DefinitionData {
+    type: string;
+    data: LinkData;
+}
+/**
+ * Virtual file definition.
+ *
+ * @internal
+ */
+export interface Definition {
+    specversion: string;
+    definition: any;
+}

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@twintag/twintag-sdk",
+  "version": "0.2.235-TTPL-1970-twintagsdk-397570c85978488f2e5cebf3cab22c0a2faa6217",
+  "description": "Twintag SDK",
+  "author": "Twintag",
+  "license": "",
+  "repository": "git+https://github.com/esoptra/twintag-sdk.git",
+  "main": "lib/twintag.js",
+  "module": "lib/twintag.esm.js",
+  "types": "lib/types/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "private": false
+}