@kmlckj/licos-platform-sdk 0.6.3 → 0.6.4

package/src/index.d.ts

@@ -1,208 +1,251 @@
-export class PlatformSdkError extends Error {
-  status?: number;
-  code?: number;
-  details?: unknown;
-}
-
-export class ConfigurationError extends PlatformSdkError {}
-export class ApiError extends PlatformSdkError {}
-
-export interface DatabaseFilter {
-  field: string;
-  op: 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'is_null' | 'is_not_null' | 'like' | 'ilike' | string;
-  value?: unknown;
-}
-
-export interface DatabaseOrderBy {
-  field: string;
-  direction?: 'asc' | 'desc';
-}
-
-export interface DatabaseRange {
-  from: number;
-  to: number;
-}
-
-export interface DatabaseResponse {
-  data?: Record<string, unknown>[];
-  count?: number;
-  affectedRows?: number;
-  message?: string;
-  [key: string]: unknown;
-}
-
-export interface DatabaseQueryOptions {
-  select?: string | string[];
-  filters?: DatabaseFilter[];
-  orderBy?: DatabaseOrderBy[];
-  range?: DatabaseRange;
-  limit?: number;
-  offset?: number;
-  count?: boolean;
-  head?: boolean;
-}
-
-export interface DatabaseMutationOptions {
-  row?: Record<string, unknown>;
-  rows?: Record<string, unknown>[];
-  values?: Record<string, unknown>;
-  filters?: DatabaseFilter[];
-  updates?: Array<{ filters?: DatabaseFilter[]; values?: Record<string, unknown> }>;
-  deletes?: Array<{ filters?: DatabaseFilter[] }>;
-  conflictKeys?: string[];
-  returning?: boolean;
-}
-
-export interface DatabaseOperation {
-  type: 'query' | 'insert' | 'update' | 'delete' | 'upsert' | string;
-  request: Record<string, unknown>;
-}
-
-export interface TableQuery {
-  select(...fields: string[]): TableQuery;
-  filter(field: string, op: string, value?: unknown): TableQuery;
-  eq(field: string, value: unknown): TableQuery;
-  neq(field: string, value: unknown): TableQuery;
-  gt(field: string, value: unknown): TableQuery;
-  gte(field: string, value: unknown): TableQuery;
-  lt(field: string, value: unknown): TableQuery;
-  lte(field: string, value: unknown): TableQuery;
-  in(field: string, value: unknown[]): TableQuery;
-  notIn(field: string, value: unknown[]): TableQuery;
-  isNull(field: string): TableQuery;
-  isNotNull(field: string): TableQuery;
-  like(field: string, value: string): TableQuery;
-  ilike(field: string, value: string): TableQuery;
-  order(field: string, options?: { desc?: boolean }): TableQuery;
-  range(from: number, to: number): TableQuery;
-  limit(value: number): TableQuery;
-  offset(value: number): TableQuery;
-  withCount(options?: { head?: boolean }): TableQuery;
-  execute(): Promise<DatabaseResponse>;
-  single(): Promise<DatabaseResponse>;
-  maybeSingle(): Promise<DatabaseResponse>;
-}
-
-export function query(table: string, options?: DatabaseQueryOptions): Promise<DatabaseResponse>;
-export function single(table: string, options?: DatabaseQueryOptions & { maybe?: boolean }): Promise<DatabaseResponse>;
-export function maybeSingle(table: string, options?: DatabaseQueryOptions): Promise<DatabaseResponse>;
-export function aggregate(table: string, aggregateName: string, options?: { field?: string; groupBy?: string[]; filters?: DatabaseFilter[] }): Promise<DatabaseResponse>;
-export function insert(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
-export function updateRows(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
-export function deleteRows(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
-export function upsert(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
-export function transaction(operations: DatabaseOperation[]): Promise<DatabaseResponse[]>;
-export function rpc(functionName: string, args?: Record<string, unknown>): Promise<DatabaseResponse>;
-export function table(name: string): TableQuery;
-
-export const database: {
-  query: typeof query;
-  single: typeof single;
-  maybeSingle: typeof maybeSingle;
-  aggregate: typeof aggregate;
-  insert: typeof insert;
-  updateRows: typeof updateRows;
-  deleteRows: typeof deleteRows;
-  upsert: typeof upsert;
-  transaction: typeof transaction;
-  rpc: typeof rpc;
-  table: typeof table;
-};
-
-export interface StorageSummary {
-  workspaceId?: string;
-  projectId?: string;
-  scope?: string;
-  bucketName?: string;
-  usedSizeBytes?: number;
-  fileCount?: number;
-  folderCount?: number;
-  serviceEnabled?: boolean;
-  [key: string]: unknown;
-}
-
-export interface StorageFolder {
-  id?: string;
-  workspaceId?: string;
-  projectId?: string;
-  scope?: string;
-  parentId?: string | null;
-  folderName?: string;
-  folderPath?: string;
-  createdAt?: string;
-  updatedAt?: string;
-  [key: string]: unknown;
-}
-
-export interface StorageFile {
-  id?: string;
-  workspaceId?: string;
-  projectId?: string;
-  scope?: string;
-  folderId?: string | null;
-  folderPath?: string;
-  fileName?: string;
-  contentType?: string;
-  sizeBytes?: number;
-  storageBucket?: string;
-  storageKey?: string;
-  downloadUrl?: string;
-  createdAt?: string;
-  updatedAt?: string;
-  [key: string]: unknown;
-}
-
-export interface StorageEntries {
-  currentFolderId?: string | null;
-  currentFolderName?: string;
-  currentFolderPath?: string;
-  breadcrumbs?: unknown[];
-  folders?: StorageFolder[];
-  files?: StorageFile[];
-  [key: string]: unknown;
-}
-
-export interface UploadFileOptions {
-  folderId?: string;
-  fileName?: string;
-  contentType?: string;
-}
-
-export const MAX_UPLOAD_FILE_BYTES: number;
-
-export interface ShareUrlOptions {
-  expirySeconds?: number;
-}
-
-export function summary(): Promise<StorageSummary>;
-export function listFolders(): Promise<StorageFolder[]>;
-export function listEntries(options?: { folderId?: string }): Promise<StorageEntries>;
-export function listFiles(): Promise<StorageFile[]>;
-export function createFolder(folderName: string, options?: { parentId?: string }): Promise<StorageFolder>;
-export function renameFolder(folderId: string, folderName: string): Promise<StorageFolder>;
-export function deleteFolder(folderId: string): Promise<void>;
-export function uploadFile(
-  input: string | Blob | Buffer | Uint8Array,
-  options?: UploadFileOptions,
-): Promise<StorageFile>;
-export function renameFile(fileId: string, fileName: string): Promise<StorageFile>;
-export function moveFile(fileId: string, options?: { folderId?: string }): Promise<StorageFile>;
-export function shareUrl(fileId: string, options?: ShareUrlOptions): Promise<{ url?: string; expiresAt?: string; [key: string]: unknown }>;
-export function objectExists(options?: { fileId?: string; objectKey?: string }): Promise<{ fileId?: string; bucketName?: string; objectKey?: string; exists?: boolean; [key: string]: unknown }>;
-export function deleteFile(fileId: string): Promise<void>;
-
-export const storage: {
-  summary: typeof summary;
-  listFolders: typeof listFolders;
-  listEntries: typeof listEntries;
-  listFiles: typeof listFiles;
-  createFolder: typeof createFolder;
-  renameFolder: typeof renameFolder;
-  deleteFolder: typeof deleteFolder;
-  uploadFile: typeof uploadFile;
-  renameFile: typeof renameFile;
-  moveFile: typeof moveFile;
-  shareUrl: typeof shareUrl;
-  objectExists: typeof objectExists;
-  deleteFile: typeof deleteFile;
-};
+export class PlatformSdkError extends Error {
+  status?: number;
+  code?: number;
+  details?: unknown;
+}
+
+export class ConfigurationError extends PlatformSdkError {}
+export class ApiError extends PlatformSdkError {}
+
+export interface DatabaseFilter {
+  field: string;
+  op: 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'is_null' | 'is_not_null' | 'like' | 'ilike' | string;
+  value?: unknown;
+}
+
+export interface DatabaseOrderBy {
+  field: string;
+  direction?: 'asc' | 'desc';
+}
+
+export interface DatabaseRange {
+  from: number;
+  to: number;
+}
+
+export interface DatabaseResponse {
+  data?: Record<string, unknown>[];
+  count?: number;
+  affectedRows?: number;
+  message?: string;
+  [key: string]: unknown;
+}
+
+export interface DatabaseQueryOptions {
+  select?: string | string[];
+  filters?: DatabaseFilter[];
+  orderBy?: DatabaseOrderBy[];
+  range?: DatabaseRange;
+  limit?: number;
+  offset?: number;
+  count?: boolean;
+  head?: boolean;
+}
+
+export interface DatabaseMutationOptions {
+  row?: Record<string, unknown>;
+  rows?: Record<string, unknown>[];
+  values?: Record<string, unknown>;
+  filters?: DatabaseFilter[];
+  updates?: Array<{ filters?: DatabaseFilter[]; values?: Record<string, unknown> }>;
+  deletes?: Array<{ filters?: DatabaseFilter[] }>;
+  conflictKeys?: string[];
+  returning?: boolean;
+}
+
+export interface DatabaseOperation {
+  type: 'query' | 'insert' | 'update' | 'delete' | 'upsert' | string;
+  request: Record<string, unknown>;
+}
+
+export interface DatabaseSchemaColumn {
+  name: string;
+  type?: string;
+  nullable?: boolean;
+  primaryKey?: boolean;
+  defaultValue?: string | null;
+  [key: string]: unknown;
+}
+
+export interface DatabaseSchemaTable {
+  schema?: string;
+  name: string;
+  description?: string | null;
+  columns?: DatabaseSchemaColumn[];
+  indexes?: unknown[];
+  foreignKeys?: unknown[];
+  constraints?: unknown[];
+  [key: string]: unknown;
+}
+
+export interface DatabaseSchema {
+  databaseId?: string;
+  environment?: 'dev' | 'prod' | string;
+  tables?: DatabaseSchemaTable[];
+  views?: unknown[];
+  functions?: unknown[];
+  enums?: unknown[];
+  [key: string]: unknown;
+}
+
+export interface GenerateOrmOptions {
+  language: 'typescript' | 'python' | 'ts' | 'py' | string;
+  orm?: 'drizzle' | 'sqlalchemy' | string;
+}
+
+export interface TableQuery {
+  select(...fields: string[]): TableQuery;
+  filter(field: string, op: string, value?: unknown): TableQuery;
+  eq(field: string, value: unknown): TableQuery;
+  neq(field: string, value: unknown): TableQuery;
+  gt(field: string, value: unknown): TableQuery;
+  gte(field: string, value: unknown): TableQuery;
+  lt(field: string, value: unknown): TableQuery;
+  lte(field: string, value: unknown): TableQuery;
+  in(field: string, value: unknown[]): TableQuery;
+  notIn(field: string, value: unknown[]): TableQuery;
+  isNull(field: string): TableQuery;
+  isNotNull(field: string): TableQuery;
+  like(field: string, value: string): TableQuery;
+  ilike(field: string, value: string): TableQuery;
+  order(field: string, options?: { desc?: boolean }): TableQuery;
+  range(from: number, to: number): TableQuery;
+  limit(value: number): TableQuery;
+  offset(value: number): TableQuery;
+  withCount(options?: { head?: boolean }): TableQuery;
+  execute(): Promise<DatabaseResponse>;
+  single(): Promise<DatabaseResponse>;
+  maybeSingle(): Promise<DatabaseResponse>;
+}
+
+export function query(table: string, options?: DatabaseQueryOptions): Promise<DatabaseResponse>;
+export function single(table: string, options?: DatabaseQueryOptions & { maybe?: boolean }): Promise<DatabaseResponse>;
+export function maybeSingle(table: string, options?: DatabaseQueryOptions): Promise<DatabaseResponse>;
+export function aggregate(table: string, aggregateName: string, options?: { field?: string; groupBy?: string[]; filters?: DatabaseFilter[] }): Promise<DatabaseResponse>;
+export function insert(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
+export function updateRows(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
+export function deleteRows(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
+export function upsert(table: string, options?: DatabaseMutationOptions): Promise<DatabaseResponse>;
+export function transaction(operations: DatabaseOperation[]): Promise<DatabaseResponse[]>;
+export function rpc(functionName: string, args?: Record<string, unknown>): Promise<DatabaseResponse>;
+export function getSchema(): Promise<DatabaseSchema>;
+export function defaultOrm(language: string): string;
+export function generateOrm(schemaPayload: DatabaseSchema, options: GenerateOrmOptions): string;
+export function exportOrm(options: GenerateOrmOptions): Promise<string>;
+export function table(name: string): TableQuery;
+
+export const database: {
+  query: typeof query;
+  single: typeof single;
+  maybeSingle: typeof maybeSingle;
+  aggregate: typeof aggregate;
+  insert: typeof insert;
+  updateRows: typeof updateRows;
+  deleteRows: typeof deleteRows;
+  upsert: typeof upsert;
+  transaction: typeof transaction;
+  rpc: typeof rpc;
+  getSchema: typeof getSchema;
+  defaultOrm: typeof defaultOrm;
+  generateOrm: typeof generateOrm;
+  exportOrm: typeof exportOrm;
+  table: typeof table;
+};
+
+export interface StorageSummary {
+  workspaceId?: string;
+  projectId?: string;
+  scope?: string;
+  bucketName?: string;
+  usedSizeBytes?: number;
+  fileCount?: number;
+  folderCount?: number;
+  serviceEnabled?: boolean;
+  [key: string]: unknown;
+}
+
+export interface StorageFolder {
+  id?: string;
+  workspaceId?: string;
+  projectId?: string;
+  scope?: string;
+  parentId?: string | null;
+  folderName?: string;
+  folderPath?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  [key: string]: unknown;
+}
+
+export interface StorageFile {
+  id?: string;
+  workspaceId?: string;
+  projectId?: string;
+  scope?: string;
+  folderId?: string | null;
+  folderPath?: string;
+  fileName?: string;
+  contentType?: string;
+  sizeBytes?: number;
+  storageBucket?: string;
+  storageKey?: string;
+  downloadUrl?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  [key: string]: unknown;
+}
+
+export interface StorageEntries {
+  currentFolderId?: string | null;
+  currentFolderName?: string;
+  currentFolderPath?: string;
+  breadcrumbs?: unknown[];
+  folders?: StorageFolder[];
+  files?: StorageFile[];
+  [key: string]: unknown;
+}
+
+export interface UploadFileOptions {
+  folderId?: string;
+  fileName?: string;
+  contentType?: string;
+}
+
+export const MAX_UPLOAD_FILE_BYTES: number;
+
+export interface ShareUrlOptions {
+  expirySeconds?: number;
+}
+
+export function summary(): Promise<StorageSummary>;
+export function listFolders(): Promise<StorageFolder[]>;
+export function listEntries(options?: { folderId?: string }): Promise<StorageEntries>;
+export function listFiles(): Promise<StorageFile[]>;
+export function createFolder(folderName: string, options?: { parentId?: string }): Promise<StorageFolder>;
+export function renameFolder(folderId: string, folderName: string): Promise<StorageFolder>;
+export function deleteFolder(folderId: string): Promise<void>;
+export function uploadFile(
+  input: string | Blob | Buffer | Uint8Array,
+  options?: UploadFileOptions,
+): Promise<StorageFile>;
+export function renameFile(fileId: string, fileName: string): Promise<StorageFile>;
+export function moveFile(fileId: string, options?: { folderId?: string }): Promise<StorageFile>;
+export function shareUrl(fileId: string, options?: ShareUrlOptions): Promise<{ url?: string; expiresAt?: string; [key: string]: unknown }>;
+export function objectExists(options?: { fileId?: string; objectKey?: string }): Promise<{ fileId?: string; bucketName?: string; objectKey?: string; exists?: boolean; [key: string]: unknown }>;
+export function deleteFile(fileId: string): Promise<void>;
+
+export const storage: {
+  summary: typeof summary;
+  listFolders: typeof listFolders;
+  listEntries: typeof listEntries;
+  listFiles: typeof listFiles;
+  createFolder: typeof createFolder;
+  renameFolder: typeof renameFolder;
+  deleteFolder: typeof deleteFolder;
+  uploadFile: typeof uploadFile;
+  renameFile: typeof renameFile;
+  moveFile: typeof moveFile;
+  shareUrl: typeof shareUrl;
+  objectExists: typeof objectExists;
+  deleteFile: typeof deleteFile;
+};