{"id":39486992,"url":"https://github.com/vtex-apps/file-manager-graphql","last_synced_at":"2026-01-18T05:27:29.432Z","repository":{"id":34682311,"uuid":"140013568","full_name":"vtex-apps/file-manager-graphql","owner":"vtex-apps","description":"GraphQL wrapper for VTEX file manager","archived":false,"fork":false,"pushed_at":"2025-08-18T19:01:41.000Z","size":353,"stargazers_count":5,"open_issues_count":1,"forks_count":4,"subscribers_count":48,"default_branch":"master","last_synced_at":"2025-08-18T21:13:00.316Z","etag":null,"topics":["srv-io-web-framework","xp-developer"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex-apps.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-07-06T17:32:56.000Z","updated_at":"2025-08-18T19:01:44.000Z","dependencies_parsed_at":"2025-02-27T17:26:37.317Z","dependency_job_id":"403159e8-bf40-4c5f-bf03-492fbd3fc5cd","html_url":"https://github.com/vtex-apps/file-manager-graphql","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/vtex-apps/file-manager-graphql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Ffile-manager-graphql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Ffile-manager-graphql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Ffile-manager-graphql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Ffile-manager-graphql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex-apps","download_url":"https://codeload.github.com/vtex-apps/file-manager-graphql/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Ffile-manager-graphql/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28530810,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["srv-io-web-framework","xp-developer"],"created_at":"2026-01-18T05:27:28.858Z","updated_at":"2026-01-18T05:27:29.419Z","avatar_url":"https://github.com/vtex-apps.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# File Manager GraphQL\n\nA GraphQL service for managing files in VTEX applications. This service provides a simple interface for uploading, retrieving, and deleting files with support for image resizing.\n\nThis API is a GraphQL abstraction of the [vtex.file-manager@0.x](https://github.com/vtex/file-manager) app, providing a unified interface for file management.\nUsage\n\n## Features\n\n- File uploads with automatic UUID-based naming\n- File retrieval with optional image resizing\n- File URL generation for direct access\n- File deletion\n- Authentication requirements for sensitive operations\n- Support for different storage buckets\n\n\n## Usage\nTo use this API, declare it in your manifest.json file:\n\n```JSON\n\"dependencies\": {\n  \"file-manager-graphql\": \"0.x\"\n}\n```\n\n## Queries\n\n### getFileUrl\nReturns the immutable URL of a file.\n\n| Arguments | Type | Description |\n| --- | --- | --- |\n| path | [String](#string) | File path |\n| bucket | [String](#string) |  Bucket name |\n\n### getFile\n\n| Arguments | Type | Description |\n| --- | --- | --- |\n| path | [String](#string) | File path |\n| bucket | [String](#string) |  Bucket name |\n| width | [Int](#int) |  Image width |\n| height | [Int](#int) |  Image height |\n| aspect | [Boolean](#boolean) |  Maintain image aspect ratio |\n\n\n### settings\nReturns the API settings.\n\n## Mutations\n\n### uploadFile\nSaves a file and returns its immutable URL.\n\n| Arguments | Type | Description |\n| --- | --- | --- |\n| file | [File](#file) | File to be uploaded |\n| bucket | [String](#string) |  Bucket name |\n\n\n\n### deleteFile\nDeletes a file from a bucket.\n\n| Arguments | Type | Description |\n| --- | --- | --- |\n| path | [String](#string) | File path |\n| bucket | [String](#string) |  Bucket name |\n\n\n## Types\n\n### File\n\n| Field | Type | Description |\n| --- | --- | --- |\n| fileUrl | [String](#string) | File URL |\n| mimetype | [String](#string) |  File MIME type |\n| encoding | [String](#string) |  File encoding |\n\n### Settings\n\n| Field | Type | Description |\n| --- | --- | --- |\n| maxFileSizeMB | [Int](#int) | Maximum allowed file size (in MB) |\n\n\n### Examples\n\nGetting a file URL\n\n```graphql\nquery {\n  getFileUrl(path: \"path/to/file\", bucket: \"images\") {\n    fileUrl\n  }\n}\n```\n\nGetting a file\n\n```graphql\nquery {\n  getFile(path: \"path/to/file\", width: 100, height: 100, bucket: \"images\") {\n    file\n  }\n}\n```\n\nUploading a file\n\n```graphql\n\nmutation {\n  uploadFile(file: ..., bucket: \"images\") {\n    fileUrl\n  }\n}\n```\n\n## Scalars\n\n### Boolean\n\nThe `Boolean` scalar type represents `true` or `false`.\n\n### Int\n\nThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.\n\n### String\n\nThe `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.\n\n## Security\n\nThis service implements authentication directives to ensure that sensitive operations like file uploads and deletions are properly authorized.\n\n## License\n\nThis project is licensed under the terms specified in the `package.json` file.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Ffile-manager-graphql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex-apps%2Ffile-manager-graphql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Ffile-manager-graphql/lists"}