s3kit 0.1.0

package/dist/types-g2IYvH3O.d.cts

@@ -0,0 +1,123 @@
+type S3FileManagerAction = 'list' | 'search' | 'folder.create' | 'folder.delete' | 'upload.prepare' | 'file.delete' | 'file.copy' | 'file.move' | 'folder.copy' | 'folder.move' | 'preview.get';
+type S3Path = string;
+interface S3FileManagerAuthContext {
+    userId?: string;
+    [key: string]: unknown;
+}
+interface S3FileManagerAuthorizeArgs {
+    action: S3FileManagerAction;
+    path?: S3Path;
+    fromPath?: S3Path;
+    toPath?: S3Path;
+    ctx: S3FileManagerAuthContext;
+}
+type S3FileManagerAuthorizeHook = (args: S3FileManagerAuthorizeArgs) => boolean | void | Promise<boolean | void>;
+type S3FileManagerAllowActionHook = (args: S3FileManagerAuthorizeArgs) => boolean | Promise<boolean>;
+type S3FileManagerAuthorizationMode = 'allow-by-default' | 'deny-by-default';
+interface S3FolderEntry<FolderExtra = unknown> {
+    type: 'folder';
+    path: S3Path;
+    name: string;
+    extra?: FolderExtra;
+}
+interface S3FileEntry<FileExtra = unknown> {
+    type: 'file';
+    path: S3Path;
+    name: string;
+    size?: number;
+    lastModified?: string;
+    etag?: string;
+    contentType?: string;
+    extra?: FileExtra;
+}
+type S3Entry<FileExtra = unknown, FolderExtra = unknown> = S3FileEntry<FileExtra> | S3FolderEntry<FolderExtra>;
+interface S3ListOptions {
+    path: S3Path;
+    cursor?: string;
+    limit?: number;
+}
+interface S3ListResult<FileExtra = unknown, FolderExtra = unknown> {
+    path: S3Path;
+    entries: Array<S3Entry<FileExtra, FolderExtra>>;
+    nextCursor?: string;
+}
+interface S3SearchOptions {
+    query: string;
+    path?: S3Path;
+    recursive?: boolean;
+    limit?: number;
+    cursor?: string;
+}
+interface S3SearchResult<FileExtra = unknown, FolderExtra = unknown> {
+    query: string;
+    entries: Array<S3Entry<FileExtra, FolderExtra>>;
+    nextCursor?: string;
+}
+interface S3CreateFolderOptions {
+    path: S3Path;
+}
+interface S3DeleteFolderOptions {
+    path: S3Path;
+    recursive?: boolean;
+}
+interface S3DeleteFilesOptions {
+    paths: S3Path[];
+}
+interface S3CopyOptions {
+    fromPath: S3Path;
+    toPath: S3Path;
+}
+interface S3MoveOptions {
+    fromPath: S3Path;
+    toPath: S3Path;
+}
+interface S3PrepareUploadItem {
+    path: S3Path;
+    contentType?: string;
+    cacheControl?: string;
+    contentDisposition?: string;
+    metadata?: Record<string, string>;
+}
+interface S3PreparedUpload {
+    path: S3Path;
+    url: string;
+    method: 'PUT';
+    headers: Record<string, string>;
+}
+interface S3PrepareUploadsOptions {
+    items: S3PrepareUploadItem[];
+    expiresInSeconds?: number;
+}
+interface S3GetPreviewUrlOptions {
+    path: S3Path;
+    expiresInSeconds?: number;
+    inline?: boolean;
+}
+interface S3GetPreviewUrlResult {
+    path: S3Path;
+    url: string;
+    expiresAt: string;
+}
+interface S3FileDecorationArgs {
+    path: S3Path;
+    key: string;
+}
+interface S3FolderDecorationArgs {
+    path: S3Path;
+    prefix: string;
+}
+interface S3FileManagerHooks<FileExtra = unknown, FolderExtra = unknown> {
+    authorize?: S3FileManagerAuthorizeHook;
+    allowAction?: S3FileManagerAllowActionHook;
+    decorateFile?: (file: S3FileEntry<FileExtra>, args: S3FileDecorationArgs) => void | Promise<void>;
+    decorateFolder?: (folder: S3FolderEntry<FolderExtra>, args: S3FolderDecorationArgs) => void | Promise<void>;
+}
+interface S3FileManagerOptions<FileExtra = unknown, FolderExtra = unknown> {
+    bucket: string;
+    rootPrefix?: string;
+    delimiter?: string;
+    authorizationMode?: S3FileManagerAuthorizationMode;
+    hooks?: S3FileManagerHooks<FileExtra, FolderExtra>;
+}
+
+export type { S3FileManagerOptions as A, S3FileManagerAction as S, S3Path as a, S3FileManagerAuthContext as b, S3FileManagerAuthorizeArgs as c, S3FileManagerAuthorizeHook as d, S3FileManagerAllowActionHook as e, S3FileManagerAuthorizationMode as f, S3FolderEntry as g, S3FileEntry as h, S3Entry as i, S3ListOptions as j, S3ListResult as k, S3SearchOptions as l, S3SearchResult as m, S3CreateFolderOptions as n, S3DeleteFolderOptions as o, S3DeleteFilesOptions as p, S3CopyOptions as q, S3MoveOptions as r, S3PrepareUploadItem as s, S3PreparedUpload as t, S3PrepareUploadsOptions as u, S3GetPreviewUrlOptions as v, S3GetPreviewUrlResult as w, S3FileDecorationArgs as x, S3FolderDecorationArgs as y, S3FileManagerHooks as z };

package/dist/types-g2IYvH3O.d.ts

@@ -0,0 +1,123 @@
+type S3FileManagerAction = 'list' | 'search' | 'folder.create' | 'folder.delete' | 'upload.prepare' | 'file.delete' | 'file.copy' | 'file.move' | 'folder.copy' | 'folder.move' | 'preview.get';
+type S3Path = string;
+interface S3FileManagerAuthContext {
+    userId?: string;
+    [key: string]: unknown;
+}
+interface S3FileManagerAuthorizeArgs {
+    action: S3FileManagerAction;
+    path?: S3Path;
+    fromPath?: S3Path;
+    toPath?: S3Path;
+    ctx: S3FileManagerAuthContext;
+}
+type S3FileManagerAuthorizeHook = (args: S3FileManagerAuthorizeArgs) => boolean | void | Promise<boolean | void>;
+type S3FileManagerAllowActionHook = (args: S3FileManagerAuthorizeArgs) => boolean | Promise<boolean>;
+type S3FileManagerAuthorizationMode = 'allow-by-default' | 'deny-by-default';
+interface S3FolderEntry<FolderExtra = unknown> {
+    type: 'folder';
+    path: S3Path;
+    name: string;
+    extra?: FolderExtra;
+}
+interface S3FileEntry<FileExtra = unknown> {
+    type: 'file';
+    path: S3Path;
+    name: string;
+    size?: number;
+    lastModified?: string;
+    etag?: string;
+    contentType?: string;
+    extra?: FileExtra;
+}
+type S3Entry<FileExtra = unknown, FolderExtra = unknown> = S3FileEntry<FileExtra> | S3FolderEntry<FolderExtra>;
+interface S3ListOptions {
+    path: S3Path;
+    cursor?: string;
+    limit?: number;
+}
+interface S3ListResult<FileExtra = unknown, FolderExtra = unknown> {
+    path: S3Path;
+    entries: Array<S3Entry<FileExtra, FolderExtra>>;
+    nextCursor?: string;
+}
+interface S3SearchOptions {
+    query: string;
+    path?: S3Path;
+    recursive?: boolean;
+    limit?: number;
+    cursor?: string;
+}
+interface S3SearchResult<FileExtra = unknown, FolderExtra = unknown> {
+    query: string;
+    entries: Array<S3Entry<FileExtra, FolderExtra>>;
+    nextCursor?: string;
+}
+interface S3CreateFolderOptions {
+    path: S3Path;
+}
+interface S3DeleteFolderOptions {
+    path: S3Path;
+    recursive?: boolean;
+}
+interface S3DeleteFilesOptions {
+    paths: S3Path[];
+}
+interface S3CopyOptions {
+    fromPath: S3Path;
+    toPath: S3Path;
+}
+interface S3MoveOptions {
+    fromPath: S3Path;
+    toPath: S3Path;
+}
+interface S3PrepareUploadItem {
+    path: S3Path;
+    contentType?: string;
+    cacheControl?: string;
+    contentDisposition?: string;
+    metadata?: Record<string, string>;
+}
+interface S3PreparedUpload {
+    path: S3Path;
+    url: string;
+    method: 'PUT';
+    headers: Record<string, string>;
+}
+interface S3PrepareUploadsOptions {
+    items: S3PrepareUploadItem[];
+    expiresInSeconds?: number;
+}
+interface S3GetPreviewUrlOptions {
+    path: S3Path;
+    expiresInSeconds?: number;
+    inline?: boolean;
+}
+interface S3GetPreviewUrlResult {
+    path: S3Path;
+    url: string;
+    expiresAt: string;
+}
+interface S3FileDecorationArgs {
+    path: S3Path;
+    key: string;
+}
+interface S3FolderDecorationArgs {
+    path: S3Path;
+    prefix: string;
+}
+interface S3FileManagerHooks<FileExtra = unknown, FolderExtra = unknown> {
+    authorize?: S3FileManagerAuthorizeHook;
+    allowAction?: S3FileManagerAllowActionHook;
+    decorateFile?: (file: S3FileEntry<FileExtra>, args: S3FileDecorationArgs) => void | Promise<void>;
+    decorateFolder?: (folder: S3FolderEntry<FolderExtra>, args: S3FolderDecorationArgs) => void | Promise<void>;
+}
+interface S3FileManagerOptions<FileExtra = unknown, FolderExtra = unknown> {
+    bucket: string;
+    rootPrefix?: string;
+    delimiter?: string;
+    authorizationMode?: S3FileManagerAuthorizationMode;
+    hooks?: S3FileManagerHooks<FileExtra, FolderExtra>;
+}
+
+export type { S3FileManagerOptions as A, S3FileManagerAction as S, S3Path as a, S3FileManagerAuthContext as b, S3FileManagerAuthorizeArgs as c, S3FileManagerAuthorizeHook as d, S3FileManagerAllowActionHook as e, S3FileManagerAuthorizationMode as f, S3FolderEntry as g, S3FileEntry as h, S3Entry as i, S3ListOptions as j, S3ListResult as k, S3SearchOptions as l, S3SearchResult as m, S3CreateFolderOptions as n, S3DeleteFolderOptions as o, S3DeleteFilesOptions as p, S3CopyOptions as q, S3MoveOptions as r, S3PrepareUploadItem as s, S3PreparedUpload as t, S3PrepareUploadsOptions as u, S3GetPreviewUrlOptions as v, S3GetPreviewUrlResult as w, S3FileDecorationArgs as x, S3FolderDecorationArgs as y, S3FileManagerHooks as z };

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "s3kit",
+  "version": "0.1.0",
+  "description": "Secure, server-driven, framework-agnostic S3 file manager (core + HTTP adapters + client helper).",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "homepage": "https://github.com/razaanstha/s3kit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/razaanstha/s3kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/razaanstha/s3kit/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js",
+      "require": "./dist/core/index.cjs"
+    },
+    "./http": {
+      "types": "./dist/http/index.d.ts",
+      "import": "./dist/http/index.js",
+      "require": "./dist/http/index.cjs"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.cjs"
+    },
+    "./adapters/express": {
+      "types": "./dist/adapters/express.d.ts",
+      "import": "./dist/adapters/express.js",
+      "require": "./dist/adapters/express.cjs"
+    },
+    "./adapters/next": {
+      "types": "./dist/adapters/next.d.ts",
+      "import": "./dist/adapters/next.js",
+      "require": "./dist/adapters/next.cjs"
+    },
+    "./adapters/fetch": {
+      "types": "./dist/adapters/fetch.d.ts",
+      "import": "./dist/adapters/fetch.js",
+      "require": "./dist/adapters/fetch.cjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "npm run build && node --test",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "oxlint": "bunx oxlint ./src ./examples",
+    "oxfmt": "bunx oxfmt ./src ./examples",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.760.0",
+    "@aws-sdk/s3-request-presigner": "^3.760.0",
+    "@base-ui/react": "^1.0.0"
+  },
+  "devDependencies": {
+    "@phosphor-icons/react": "^2.1.10",
+    "@types/express": "^4.17.21",
+    "@types/react": "^19.2.7",
+    "express": "^4.21.2",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3"
+  },
+  "peerDependencies": {
+    "@phosphor-icons/react": "^2.1.10",
+    "express": "^4.18.0 || ^5.0.0",
+    "react": "^19.2.3"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}