@tailor-platform/function-types 0.7.2 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @tailor-platform/function-types
 
+## 0.8.1
+
+### Patch Changes
+
+- [#128](https://github.com/tailor-platform/function/pull/128) [`84ce6ba`](https://github.com/tailor-platform/function/commit/84ce6ba209e0c7bf51d0646ecfdcc32403904da6) Thanks [@k1LoW](https://github.com/k1LoW)! - feat: Add tailor.idp namespace type definitions
+
 ## 0.7.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/function-types",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "description": "TypeScript types for Tailor Platform Function service",
   "repository": {
     "type": "git",

package/tailor.d.ts

@@ -117,7 +117,7 @@ declare namespace tailor.iconv {
  */
 declare class TailorDBFileError extends Error {
   name: 'TailorDBFileError';
-  code?: 'INVALID_PARAMS' | 'INVALID_DATA_TYPE' | 'OPERATION_FAILED' | 'DELETE_FAILED' | 'STREAM_OPEN_FAILED' | 'STREAM_READ_ERROR' | 'STREAM_ERROR';
+  code?: 'INVALID_PARAMS' | 'INVALID_DATA_TYPE' | 'OPERATION_FAILED' | 'DELETE_FAILED' | 'STREAM_OPEN_FAILED' | 'STREAM_READ_ERROR' | 'STREAM_ERROR' | 'FILE_TOO_LARGE';
   cause?: unknown;
 }
 
@@ -135,6 +135,8 @@ interface UploadMetadata {
 interface DownloadMetadata {
   contentType: string;
   fileSize: number;
+  sha256sum: string;
+  lastUploadedAt: string;
 }
 
 /**
@@ -179,6 +181,14 @@ interface FileDownloadResponse {
   metadata: DownloadMetadata;
 }
 
+/**
+ * Download as Base64 response interface
+ */
+interface FileDownloadAsBase64Response {
+  data: string;
+  metadata: DownloadMetadata;
+}
+
 /**
  * Stream chunk types
  */
@@ -213,6 +223,7 @@ interface TailorDBFileAPI {
 
   /**
    * Download a file from TailorDB
+   * @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use openDownloadStream() for large files
    */
   download(
     namespace: string,
@@ -221,6 +232,20 @@ interface TailorDBFileAPI {
     recordId: string
   ): Promise<FileDownloadResponse>;
 
+  /**
+   * Download a file from TailorDB as Base64 string
+   * Unlike download which returns decoded binary data (Uint8Array),
+   * this returns the raw Base64-encoded string for use cases requiring
+   * Base64 format (e.g., embedding in JSON responses, data URIs)
+   * @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use openDownloadStream() for large files
+   */
+  downloadAsBase64(
+    namespace: string,
+    typeName: string,
+    fieldName: string,
+    recordId: string
+  ): Promise<FileDownloadAsBase64Response>;
+
   /**
    * Delete a file from TailorDB
    */
@@ -252,6 +277,132 @@ interface TailorDBFileAPI {
   ): Promise<FileStreamIterator>;
 }
 
+declare namespace tailor.idp {
+  /**
+   * Configuration for creating an IDP Client
+   */
+  interface ClientConfig {
+    namespace: string;
+  }
+
+  /**
+   * User object returned from IDP operations
+   */
+  interface User {
+    id: string;
+    name: string;
+    disabled: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+  }
+
+  /**
+   * Query options for filtering users
+   */
+  interface UserQuery {
+    /** Filter by user IDs */
+    ids?: string[];
+    /** Filter by user names */
+    names?: string[];
+  }
+
+  /**
+   * Options for listing users
+   */
+  interface ListUsersOptions {
+    /** Maximum number of users to return */
+    first?: number;
+    /** Page token for pagination */
+    after?: string;
+    /** Query filter for users */
+    query?: UserQuery;
+  }
+
+  /**
+   * Response from listing users
+   */
+  interface ListUsersResponse {
+    users: User[];
+    nextPageToken: string | null;
+    totalCount: number;
+  }
+
+  /**
+   * Input for creating a new user
+   */
+  interface CreateUserInput {
+    /** The user's name (typically email) */
+    name: string;
+    /** The user's password */
+    password: string;
+    /** Whether the user is disabled */
+    disabled?: boolean;
+  }
+
+  /**
+   * Input for updating an existing user
+   */
+  interface UpdateUserInput {
+    /** The user's ID */
+    id: string;
+    /** New name for the user */
+    name?: string;
+    /** New password for the user */
+    password?: string;
+    /** New disabled status for the user */
+    disabled?: boolean;
+  }
+
+  /**
+   * Input for sending a password reset email
+   */
+  interface SendPasswordResetEmailInput {
+    /** The ID of the user */
+    userId: string;
+    /** The URI to redirect to after password reset */
+    redirectUri: string;
+  }
+
+  /**
+   * IDP Client for user management operations
+   */
+  class Client {
+    constructor(config: ClientConfig);
+
+    /**
+     * List users in the namespace with optional filtering and pagination.
+     */
+    users(options?: ListUsersOptions): Promise<ListUsersResponse>;
+
+    /**
+     * Get a user by ID.
+     */
+    user(userId: string): Promise<User>;
+
+    /**
+     * Create a new user.
+     */
+    createUser(input: CreateUserInput): Promise<User>;
+
+    /**
+     * Update an existing user.
+     */
+    updateUser(input: UpdateUserInput): Promise<User>;
+
+    /**
+     * Delete a user by ID.
+     * @returns True if successful
+     */
+    deleteUser(userId: string): Promise<boolean>;
+
+    /**
+     * Send a password reset email to a user.
+     * @returns True if successful
+     */
+    sendPasswordResetEmail(input: SendPasswordResetEmailInput): Promise<boolean>;
+  }
+}
+
 declare namespace tailor.workflow {
     /**
      * Specifies the machine user that should be used to execute the workflow.