@revenexx/sdk 0.0.2

package/src/services/tokens.ts

@@ -0,0 +1,314 @@
+import { Service } from '../service';
+import { RevenexxException, Client, type Payload, UploadProgress } from '../client';
+import type { Models } from '../models';
+
+
+export class Tokens {
+    client: Client;
+
+    constructor(client: Client) {
+        this.client = client;
+    }
+
+    /**
+     * List all the tokens created for a specific file or bucket. You can use the query params to filter your results.
+     *
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File unique ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceTokenList>}
+     */
+    tokensList(params: { bucketId: string, fileId: string, queries?: string[], total?: boolean }): Promise<Models.ResourceTokenList>;
+    /**
+     * List all the tokens created for a specific file or bucket. You can use the query params to filter your results.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File unique ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceTokenList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    tokensList(bucketId: string, fileId: string, queries?: string[], total?: boolean): Promise<Models.ResourceTokenList>;
+    tokensList(
+        paramsOrFirst: { bucketId: string, fileId: string, queries?: string[], total?: boolean } | string,
+        ...rest: [(string)?, (string[])?, (boolean)?]    
+    ): Promise<Models.ResourceTokenList> {
+        let params: { bucketId: string, fileId: string, queries?: string[], total?: boolean };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, queries?: string[], total?: boolean };
+        } else {
+            params = {
+                bucketId: paramsOrFirst as string,
+                fileId: rest[0] as string,
+                queries: rest[1] as string[],
+                total: rest[2] as boolean            
+            };
+        }
+        
+        const bucketId = params.bucketId;
+        const fileId = params.fileId;
+        const queries = params.queries;
+        const total = params.total;
+
+        if (typeof bucketId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "bucketId"');
+        }
+        if (typeof fileId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "fileId"');
+        }
+
+        const apiPath = '/v1/tokens/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload: Payload = {};
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
+        }
+        if (typeof total !== 'undefined') {
+            payload['total'] = total;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.
+     *
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File unique ID.
+     * @param {string} params.expire - Token expiry date
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceToken>}
+     */
+    tokensCreateFileToken(params: { bucketId: string, fileId: string, expire?: string }): Promise<Models.ResourceToken>;
+    /**
+     * Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File unique ID.
+     * @param {string} expire - Token expiry date
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceToken>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    tokensCreateFileToken(bucketId: string, fileId: string, expire?: string): Promise<Models.ResourceToken>;
+    tokensCreateFileToken(
+        paramsOrFirst: { bucketId: string, fileId: string, expire?: string } | string,
+        ...rest: [(string)?, (string)?]    
+    ): Promise<Models.ResourceToken> {
+        let params: { bucketId: string, fileId: string, expire?: string };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, expire?: string };
+        } else {
+            params = {
+                bucketId: paramsOrFirst as string,
+                fileId: rest[0] as string,
+                expire: rest[1] as string            
+            };
+        }
+        
+        const bucketId = params.bucketId;
+        const fileId = params.fileId;
+        const expire = params.expire;
+
+        if (typeof bucketId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "bucketId"');
+        }
+        if (typeof fileId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "fileId"');
+        }
+
+        const apiPath = '/v1/tokens/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload: Payload = {};
+        if (typeof expire !== 'undefined') {
+            payload['expire'] = expire;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Delete a token by its unique ID.
+     *
+     * @param {string} params.tokenId - Token ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    tokensDelete(params: { tokenId: string }): Promise<{}>;
+    /**
+     * Delete a token by its unique ID.
+     *
+     * @param {string} tokenId - Token ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    tokensDelete(tokenId: string): Promise<{}>;
+    tokensDelete(
+        paramsOrFirst: { tokenId: string } | string    
+    ): Promise<{}> {
+        let params: { tokenId: string };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { tokenId: string };
+        } else {
+            params = {
+                tokenId: paramsOrFirst as string            
+            };
+        }
+        
+        const tokenId = params.tokenId;
+
+        if (typeof tokenId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "tokenId"');
+        }
+
+        const apiPath = '/v1/tokens/{tokenId}'.replace('{tokenId}', tokenId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'delete',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Get a token by its unique ID.
+     *
+     * @param {string} params.tokenId - Token ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceToken>}
+     */
+    tokensGet(params: { tokenId: string }): Promise<Models.ResourceToken>;
+    /**
+     * Get a token by its unique ID.
+     *
+     * @param {string} tokenId - Token ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceToken>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    tokensGet(tokenId: string): Promise<Models.ResourceToken>;
+    tokensGet(
+        paramsOrFirst: { tokenId: string } | string    
+    ): Promise<Models.ResourceToken> {
+        let params: { tokenId: string };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { tokenId: string };
+        } else {
+            params = {
+                tokenId: paramsOrFirst as string            
+            };
+        }
+        
+        const tokenId = params.tokenId;
+
+        if (typeof tokenId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "tokenId"');
+        }
+
+        const apiPath = '/v1/tokens/{tokenId}'.replace('{tokenId}', tokenId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Update a token by its unique ID. Use this endpoint to update a token's expiry date.
+     *
+     * @param {string} params.tokenId - Token unique ID.
+     * @param {string} params.expire - File token expiry date
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceToken>}
+     */
+    tokensUpdate(params: { tokenId: string, expire?: string }): Promise<Models.ResourceToken>;
+    /**
+     * Update a token by its unique ID. Use this endpoint to update a token's expiry date.
+     *
+     * @param {string} tokenId - Token unique ID.
+     * @param {string} expire - File token expiry date
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ResourceToken>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    tokensUpdate(tokenId: string, expire?: string): Promise<Models.ResourceToken>;
+    tokensUpdate(
+        paramsOrFirst: { tokenId: string, expire?: string } | string,
+        ...rest: [(string)?]    
+    ): Promise<Models.ResourceToken> {
+        let params: { tokenId: string, expire?: string };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { tokenId: string, expire?: string };
+        } else {
+            params = {
+                tokenId: paramsOrFirst as string,
+                expire: rest[0] as string            
+            };
+        }
+        
+        const tokenId = params.tokenId;
+        const expire = params.expire;
+
+        if (typeof tokenId === 'undefined') {
+            throw new RevenexxException('Missing required parameter: "tokenId"');
+        }
+
+        const apiPath = '/v1/tokens/{tokenId}'.replace('{tokenId}', tokenId);
+        const payload: Payload = {};
+        if (typeof expire !== 'undefined') {
+            payload['expire'] = expire;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+}

package/types/channel.d.ts

@@ -0,0 +1,74 @@
+interface Database {
+    _db: any;
+}
+interface Collection {
+    _coll: any;
+}
+interface Document {
+    _doc: any;
+}
+interface TablesDB {
+    _tdb: any;
+}
+interface Table {
+    _tbl: any;
+}
+interface Row {
+    _row: any;
+}
+interface Bucket {
+    _bkt: any;
+}
+interface File {
+    _file: any;
+}
+interface Func {
+    _fn: any;
+}
+interface Execution {
+    _exec: any;
+}
+interface Team {
+    _team: any;
+}
+interface Membership {
+    _mem: any;
+}
+interface Resolved {
+    _res: any;
+}
+type Actionable = Document | Row | File | Team | Membership;
+export declare class Channel<T> {
+    private readonly segments;
+    _type: T;
+    private constructor();
+    private next;
+    private resolve;
+    toString(): string;
+    collection(this: Channel<Database>, id: string): Channel<Collection>;
+    document(this: Channel<Collection>, id?: string): Channel<Document>;
+    table(this: Channel<TablesDB>, id: string): Channel<Table>;
+    row(this: Channel<Table>, id?: string): Channel<Row>;
+    file(this: Channel<Bucket>, id?: string): Channel<File>;
+    create(this: Channel<Actionable>): Channel<Resolved>;
+    upsert(this: Channel<Document | Row>): Channel<Resolved>;
+    update(this: Channel<Actionable>): Channel<Resolved>;
+    delete(this: Channel<Actionable>): Channel<Resolved>;
+    static database(id: string): Channel<Database>;
+    static execution(id: string): Channel<Execution>;
+    static tablesdb(id: string): Channel<TablesDB>;
+    static bucket(id: string): Channel<Bucket>;
+    static function(id: string): Channel<Func>;
+    static team(id: string): Channel<Team>;
+    static membership(id: string): Channel<Membership>;
+    static account(): string;
+    static documents(): string;
+    static rows(): string;
+    static files(): string;
+    static executions(): string;
+    static teams(): string;
+    static memberships(): string;
+}
+export type ActionableChannel = Channel<Document> | Channel<Row> | Channel<File> | Channel<Execution> | Channel<Team> | Channel<Membership>;
+export type ResolvedChannel = Channel<Resolved>;
+export {};

package/types/client.d.ts

@@ -0,0 +1,211 @@
+import { Models } from './models';
+import { Channel, ActionableChannel, ResolvedChannel } from './channel';
+import { Query } from './query';
+/**
+ * Payload type representing a key-value pair with string keys and any values.
+ */
+type Payload = {
+    [key: string]: any;
+};
+/**
+ * Headers type representing a key-value pair with string keys and string values.
+ */
+type Headers = {
+    [key: string]: string;
+};
+/**
+ * Realtime event response structure with generic payload type.
+ */
+type RealtimeResponseEvent<T extends unknown> = {
+    /**
+     * List of event names associated with the response.
+     */
+    events: string[];
+    /**
+     * List of channel names associated with the response.
+     */
+    channels: string[];
+    /**
+     * Timestamp indicating the time of the event.
+     */
+    timestamp: string;
+    /**
+     * Payload containing event-specific data.
+     */
+    payload: T;
+    /**
+     * Subscription IDs this event matches (from backend, optional).
+     */
+    subscriptions?: string[];
+};
+/**
+ * Type representing upload progress information.
+ */
+type UploadProgress = {
+    /**
+     * Identifier for the upload progress.
+     */
+    $id: string;
+    /**
+     * Current progress of the upload (in percentage).
+     */
+    progress: number;
+    /**
+     * Total size uploaded (in bytes) during the upload process.
+     */
+    sizeUploaded: number;
+    /**
+     * Total number of chunks that need to be uploaded.
+     */
+    chunksTotal: number;
+    /**
+     * Number of chunks that have been successfully uploaded.
+     */
+    chunksUploaded: number;
+};
+/**
+ * Exception thrown by the  package
+ */
+declare class RevenexxException extends Error {
+    /**
+     * The error code associated with the exception.
+     */
+    code: number;
+    /**
+     * The response string associated with the exception.
+     */
+    response: string;
+    /**
+     * Error type.
+     * See [Error Types](https://revenexx.com/docs/response-codes#errorTypes) for more information.
+     */
+    type: string;
+    /**
+     * Initializes a Revenexx Exception.
+     *
+     * @param {string} message - The error message.
+     * @param {number} code - The error code. Default is 0.
+     * @param {string} type - The error type. Default is an empty string.
+     * @param {string} response - The response string. Default is an empty string.
+     */
+    constructor(message: string, code?: number, type?: string, response?: string);
+}
+/**
+ * Client that handles requests to Revenexx
+ */
+declare class Client {
+    static CHUNK_SIZE: number;
+    /**
+     * Holds configuration such as project.
+     */
+    config: {
+        endpoint: string;
+        endpointRealtime: string;
+        tenant: string;
+        apikeyauth: string;
+        bearerauth: string;
+    };
+    /**
+     * Custom headers for API requests.
+     */
+    headers: Headers;
+    /**
+     * Set Endpoint
+     *
+     * Your project endpoint
+     *
+     * @param {string} endpoint
+     *
+     * @returns {this}
+     */
+    setEndpoint(endpoint: string): this;
+    /**
+     * Set Realtime Endpoint
+     *
+     * @param {string} endpointRealtime
+     *
+     * @returns {this}
+     */
+    setEndpointRealtime(endpointRealtime: string): this;
+    /**
+     * Set Tenant
+     *
+     * The tenant slug your requests are scoped to, sent as the
+     * X-Revenexx-Tenant header on every request.
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setTenant(value: string): this;
+    /**
+     * Set ApiKeyAuth
+     *
+     * A gateway-managed scoped API key (rvxk_…).
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setApiKeyAuth(value: string): this;
+    /**
+     * Set BearerAuth
+     *
+     * A Zitadel-issued JWT (Cockpit / interactive callers).
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setBearerAuth(value: string): this;
+    private realtime;
+    /**
+     * Subscribes to Revenexx events and passes you the payload in realtime.
+     *
+     * @deprecated Use the Realtime service instead.
+     * @see Realtime
+     *
+     * @param {string|string[]|Channel<any>|ActionableChannel|ResolvedChannel|(Channel<any>|ActionableChannel|ResolvedChannel)[]} channels
+     * Channel to subscribe - pass a single channel as a string or Channel builder instance, or multiple with an array.
+     *
+     * Possible channels are:
+     * - account
+     * - collections
+     * - collections.[ID]
+     * - collections.[ID].documents
+     * - documents
+     * - documents.[ID]
+     * - files
+     * - files.[ID]
+     * - executions
+     * - executions.[ID]
+     * - functions.[ID]
+     * - teams
+     * - teams.[ID]
+     * - memberships
+     * - memberships.[ID]
+     *
+     * You can also use Channel builders:
+     * - Channel.database('db').collection('col').document('doc').create()
+     * - Channel.bucket('bucket').file('file').update()
+     * - Channel.function('func').execution('exec').delete()
+     * - Channel.team('team').create()
+     * - Channel.membership('membership').update()
+     * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
+     * @returns {() => void} Unsubscribes from events.
+     */
+    subscribe<T extends unknown>(channels: string | string[] | Channel<any> | ActionableChannel | ResolvedChannel | (Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (payload: RealtimeResponseEvent<T>) => void, queries?: (string | Query)[]): () => void;
+    prepareRequest(method: string, url: URL, headers?: Headers, params?: Payload): {
+        uri: string;
+        options: RequestInit;
+    };
+    chunkedUpload(method: string, url: URL, headers: Headers | undefined, originalPayload: Payload | undefined, onProgress: (progress: UploadProgress) => void): Promise<any>;
+    ping(): Promise<string>;
+    call(method: string, url: URL, headers?: Headers, params?: Payload, responseType?: string): Promise<any>;
+    static flatten(data: Payload, prefix?: string): Payload;
+}
+export { Client, RevenexxException };
+export { Query } from './query';
+export type { Models, Payload, UploadProgress };
+export type { RealtimeResponseEvent };
+export type { QueryTypes, QueryTypesList } from './query';

package/types/enums/adapter.d.ts

@@ -0,0 +1,4 @@
+export declare enum Adapter {
+    Static = "static",
+    Ssr = "ssr"
+}

package/types/enums/attribute-boolean-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeBooleanStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-datetime-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeDatetimeStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-email-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeEmailStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-enum-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeEnumStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-float-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeFloatStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-integer-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeIntegerStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-ip-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeIpStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-line-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeLineStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-longtext-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeLongtextStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/attribute-mediumtext-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeMediumtextStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}