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

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

@@ -0,0 +1,224 @@
+import { View, EmailRequest } from './view';
+import { StructuredObject } from './structuredObject';
+import { ListObject } from './listObject';
+import { Twintag } from './twintag';
+/**
+ * The project class allows you to interact with a Twintag project.
+ *
+ * To construct a project object you pass the API key you find
+ * on the Twintag project page. E.g.:
+ * ```
+ * let project = new Twintag.Project('<Project API key>')
+ * ```
+ */
+export declare class Project {
+    /**
+     * The API key passed when constructing the project object.
+     */
+    readonly apiKey: string;
+    private client;
+    private projectId;
+    private _useCaching;
+    /**
+     * Create a project
+     *
+     * @param apiKey You'll find the API Key on the Twintag project page.
+     */
+    constructor(apiKey: string);
+    /**
+     * set caching host
+     * @param val
+     * @hidden
+     */
+    useCaching(val: boolean): void;
+    /**
+     * Create a bag, automatically linked to the project.
+     */
+    createBag(): Promise<View>;
+    /**
+     * Create a {@link View | view } object with project-level privileges.
+     * Your project API key is automatically used for all changes.
+     */
+    getView(qid: string): View;
+    /**
+     * Create a {@link Twintag | twintag } object with project-level privileges.
+     * Your project API key is automatically used for all changes.
+     */
+    getTwintag(qid: string): Twintag;
+    /**
+     * List the metadata of a all twintags within your project.
+     * @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
+     * @typeParam T The objects in the resulting array will be cast to this type.
+     */
+    getMetadata<T>(lang?: string): Promise<T[]>;
+    /**
+     * Create an object for the project. Returns a StructuredObject object on which various operations can be performed.
+     *
+     * @param objectName Name with which the object is to be created
+     * @param objectAPIName APIName with which the object is to be created
+     * @param isList Optional paramaeter to specify if the object is of list type. By default false is set as the value for this param.
+     * @param isGlobal Optional parameter to specify if the object is of global type. By default false is set as the value for this param.
+     * @param keyProperty Optional parameter to specify the key property for the object is. By default no key property will be created.
+     */
+    newObject(objectName: string, objectAPIName?: string, isList?: boolean, isGlobal?: boolean, keyProperty?: string, access?: Access): Promise<StructuredObject>;
+    /**
+     * Get an object by name. Returns a StructuredObject object on which various operations can be performed.
+     *
+     * @param objectAPIName APIName of the object
+     */
+    getObject(objectAPIName: string): Promise<StructuredObject>;
+    /**
+     * Delete an object by its name
+     *
+     * @param objectAPIName Name of the object
+     */
+    deleteObject(objectAPIName: string): Promise<void>;
+    /**
+     * Delete project twintag.
+     * @param viewId view id of the twintag to be deleted.
+     *
+     * Example:
+     * ```js
+     * await project.deleteTwintag('viewid')
+     * ```
+     */
+    deleteTwintag(viewID: string): Promise<void>;
+    /**
+     * Get an object for the view
+     *
+     * Required rights: owner.
+     *
+     * @param objectAPIName Name of the object
+     *
+     * @category Structured Data
+     */
+    object(objectAPIName: string): ListObject;
+    /**
+     * @internal
+     * Get project id for when caching is enabled
+     */
+    private getProjectId;
+    /**
+     * @internal
+     * @param url
+     */
+    private getURL;
+    /**
+     * Get bags in a project
+     */
+    getBags(): Promise<Bag[]>;
+    /**
+     * Sends email
+     *
+     * @param request EmailRequest object
+     *
+     * Example:
+     *
+     * You can call this method by passing {@link EmailRequest}:
+     * ```js
+     * await projectObj.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>;
+    /**
+     * Adds languages for a project.
+     * Example:
+     * ```js
+     * await project.setAllowedLanguages(['en','nl'])
+     * ```
+     *
+     * You can set default language for project in same function as well
+     * Example:
+     * ```js
+     * await project.setAllowedLanguages(['en','nl'], 'nl')
+     * ```
+     *
+     * @param request: array of languages
+     * @param defaultLanguage: optional
+     * @category Languages
+     */
+    setAllowedLanguages(request: string[], defaultLanguage?: string): Promise<Language[]>;
+    /**
+     * Get all allowed languages for a project.
+     * Example:
+     * ```js
+     * let res = await project.getAllowedLanguages()
+     * ```
+     * @returns Promise<string[]>
+     */
+    getAllowedLanguages(): Promise<Language[]>;
+    /**
+     * Sets default language for the project.
+     * Example:
+     * ```js
+     * await project.setDefaultLanguage('nl')
+     * ```
+     *
+     * @param request: default language.
+     * @category Languages
+     */
+    setDefaultLanguage<T>(request: string): Promise<Language>;
+    /**
+     * gets default language for the project.
+     * Example:
+     * ```js
+     * await project.getDefaultLanguage()
+     * ```
+     *
+     * @category Languages
+     */
+    getDefaultLanguage(): Promise<Language>;
+}
+/**
+ * This function validates tokens provided by twintag's authentication mechanism
+ * @returns boolean specifying whether token is valid or not.
+ */
+export declare function isValidToken(secretId: string, token: string): Promise<boolean>;
+interface Bag {
+    projectId: string;
+    viewId: string;
+    type: string;
+    path: string;
+    StorageQid: string;
+}
+/**
+ * Access definition for an object.
+ *
+ * eg:
+ * <Access>{
+ *    read: [BagType.Download, BagType.Owner]
+ * }
+ *
+ * Above definition means Read access is available only for Download and Owner bags.
+ * Download and owner bags can't access the object.
+ */
+export interface Access {
+    read?: BagType[];
+    insert?: BagType[];
+    update?: BagType[];
+    delete?: BagType[];
+}
+/**
+ * BagType: Enum for type of bag.
+ */
+export declare enum BagType {
+    Download = "download",
+    Upload = "upload",
+    UploadDownload = "upload-download",
+    Owner = "owner"
+}
+/**
+ * Languages for a project
+ */
+interface Language {
+    name: string;
+    apiName: string;
+}
+export {};

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

@@ -0,0 +1,30 @@
+/**
+ * Twintag SDK.
+ *
+ * @packageDocumentation
+ */
+import { OfflineRequest } from '@twintag/model';
+/**
+ * SetHost allows you to overwrite the Twintag domain.
+ *
+ * @hidden
+ */
+export declare function setHost(host: string): void;
+/**
+ * SetAdminHost allows you to overwrite the Twintag administrative domain.
+ *
+ * @hidden
+ */
+export declare function setAdminHost(host: string): void;
+/**
+ * setCachingHost allows you to overwrite the Twintag caching domain.
+ *
+ * @hidden
+ */
+export declare function setCachingHost(host: string): void;
+/**
+ * retryRequest allows you to retry a cached/stored request
+ *
+ * @hidden
+ */
+export declare function retryRequest(request: OfflineRequest): Promise<[unknown, import("./error.model").TwintagError]>;

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

@@ -0,0 +1,123 @@
+import { Access } from './project';
+/**
+ * StructuredObject class represents an object of a project.
+ * Operations like creating attributes, getting attributes can be informed.
+ */
+export declare class StructuredObject {
+    $schemaScope?: string;
+    $qid?: string;
+    name: string;
+    apiName: string;
+    isList: boolean;
+    isGlobal: boolean;
+    keyProperty?: string;
+    access?: Access;
+    private _useCaching;
+    private client;
+    /**
+     * Create an object of StructuredObject
+     *
+     * @param apiKey You'll find the API Key on the Twintag project page.
+     */
+    constructor(apiKey: string, useCaching?: boolean);
+    /**
+     * Get the attributes of the object of the project. Returns the list of attributes.
+     */
+    getAttributes(): Promise<Attribute[]>;
+    /**
+     * Get a specific attribute by name
+     *
+     * @param attributeName Name of the attribute
+     */
+    getAttribute<attribute>(attributeName: string): Promise<attribute>;
+    /**
+     * Create a new attribute for the object of a project
+     *
+     * @param attributeName Name of the attribute
+     * @param type Type of the attribute. Use the {@link AttributeType | AttributeType} enum or "string" for string type, "number" for number type and "datetime" for a datetime type, "richtext" for rich text type, "file" for file type, "boolean" for boolean type
+     * @param positionBefore The apiName of the property before which the newly created property is placed
+     */
+    newAttribute(attributeName: string, type?: string | AttributeType, positionBefore?: string): Promise<Attribute>;
+    /**
+     * Delete a attribute for the object of a project
+     *
+     * @param attributeName Name of the attribute
+     */
+    deleteAttribute(attributeName: string): Promise<void>;
+    /**
+     * Update an attribute for an object of a project
+     *
+     * @param property The desired state of the attribute. $qid is required in the object
+     *
+     */
+    updateAttribute<attribute>(property: Attribute): Promise<attribute>;
+    /**
+     * Rename the object
+     * @param newName
+     */
+    rename(newName: string): Promise<StructuredObject>;
+    /**
+     * Update the key property of the object.
+     * If a attribute by the given name already exists, the attribute will be marked as key attribute.
+     * If the attribute by the given name doesnot exists, a new attribute will be created and marked as key attribute.
+     * If instances for the object already exist, key property for the object cannot be updated.
+     * @param attributeName
+     */
+    updateKeyAttribute(attributeName: string): Promise<StructuredObject>;
+    /**
+     * Update the access of the object.
+     */
+    updateAccess(access: Access): Promise<StructuredObject>;
+    /**
+     * Add translation column for an existing structured data object column
+     * @param langAttributes: indexed type. pass key value pair for language and corresponding column name (see example below)
+     * @param parent: api name of column for which translation column is being created
+     * Example
+     * ```js
+     * //first create column for which translation has to be added
+     * const col = await object.newAttribute('col name')
+     *
+     * let langAttr = {
+     * 'fr':'french column name',
+     * 'nl':'dutch column name'
+     * }
+     *
+     * const res = await object.addTranslationAttribute(langAttr, col.apiName)
+     * ```
+     * This will create 2 language columns, each for french and dutch language.
+     * @returns Promise<Attribute[]>
+     */
+    addTranslationAttribute(langAttributes: languageAttributes, parent: string): Promise<Attribute[]>;
+    private getTypeByName;
+    /**
+     * Get URL
+     * @internal
+     */
+    getURL(url: string, schemaScope?: string): string;
+}
+interface Attribute {
+    $schemaScope: string;
+    $object: string;
+    $qid: string;
+    name: string;
+    apiName: string;
+    type: number;
+    nextProperty: string;
+    parent: string;
+    language: string;
+}
+export interface languageAttributes {
+    [language: string]: string;
+}
+/**
+ * Types of attributes
+ */
+export declare enum AttributeType {
+    String = "string",
+    Number = "number",
+    Datetime = "datetime",
+    Richtext = "richtext",
+    File = "file",
+    Boolean = "boolean"
+}
+export {};

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

@@ -0,0 +1,38 @@
+import { ViewInit } from "./base";
+/**
+ * The twintag class allows you to interact with a view into a twintag.
+ * A view is represented by a `qid`. This is the string you see in its url:
+ * `https://twintag.io/<qid>`.
+ * A twintag can have multiple views, each view can have different rights associated.
+ * For example: owner, download-only, upload-only, ...
+ *
+ * To construct a twintag object, you pass its QID, E.g.:
+ * ```
+ * let twintag = new Zaza.Twintag(viewId)
+ * ```
+ */
+export declare class Twintag {
+    private _base;
+    /**
+     * Construct a view by its QID.
+     *
+     * @param init Internal parameter.
+     */
+    constructor(qid: string);
+    /**
+     * _setConfig allows us to pass internal state.
+     *
+     * @internal */
+    _setConfig(init: ViewInit): void;
+    /**
+     * Delete a project twintag along with its metadata (if any)
+     * This view instance should be generated with project.
+     *
+     * Example:
+     * ```js
+     * const vi = project.getView('viewid')
+     * await vi.deleteProjectTwintag()
+     * ```
+     */
+    deleteProjectTwintag(): Promise<void>;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * The twintag-sdk version.
+ */
+export declare const VERSION = "0.2.235-TTPL-1970-twintagsdk-397570c85978488f2e5cebf3cab22c0a2faa6217";