Repository

Overview

Module

package: @aerokit/sdk/platform
source: platform/repository.ts
last updated:

The Repository module provides a wrapper for the platform's RepositoryFacade, allowing developers to manage files (Resources) and folders (Collections) within the repository. It offers high-level methods for creating, retrieving, updating, and deleting resources and collections by their paths, as well as handling content in both string and byte array formats. The module abstracts the complexities of repository interactions, providing a simple interface for file management operations.

Key Features:

Resource Management: Create, retrieve, update, and delete resources (files) with support for both text and binary content.
Collection Management: Create, retrieve, and delete collections (folders), as well as manage their contents.
Metadata Access: Retrieve detailed information about resources and collections, including permissions, size, and timestamps.
Search Functionality: Search for resources using glob patterns to find files matching specific criteria.

Use Cases:

File Storage: This module is ideal for applications that need to store and manage files within the platform's repository, such as configuration files, data exports, or user-generated content.
Content Management: Developers can use this module to organize files into collections (folders) and manage their lifecycle effectively.

Example Usage:

import { Repository } from "@aerokit/sdk/platform";

// Create a new resource with text content
const resource = Repository.createResource("/myproject/data.txt", "Hello, Repository!", "text/plain");
console.log("Resource created at path:", resource.getPath());

// Update the resource content with binary data
const binaryContent = [0x48, 0x65, 0x6C, 0x6C, 0x6F]; // "Hello" in bytes
resource.setContent(binaryContent);
console.log("Resource content updated with binary data.");

// Create a new collection (folder)
const collection = Repository.createCollection("/myproject/documents");
console.log("Collection created at path:", collection.getPath());

// Move the resource into the new collection
resource.moveTo("/myproject/documents/data.txt");
console.log("Resource moved to new path:", resource.getPath());

Classes

Repository

getResource()

Retrieves a resource (file) object from the repository by its path.

ts
static getResource(path: string): Resource;
Parameter Type Description
path string The absolute path to the resource.
Returns
Type: Resource
Description: A Resource instance wrapping the native repository object.

Parameter	Type	Description
`path`	`string`	The absolute path to the resource.

createResource()

Creates a new resource (file) with content provided as a string.

ts
static createResource(path: string, content: string, contentType: string): Resource;
Parameter Type Description
path string The absolute path where the resource should be created.
content string The string content for the resource.
contentType string The MIME type of the content (e.g., "text/plain").
Returns
Type: Resource
Description: The newly created Resource instance.

Parameter	Type	Description
`path`	`string`	The absolute path where the resource should be created.
`content`	`string`	The string content for the resource.
`contentType`	`string`	The MIME type of the content (e.g., "text/plain").

createResourceNative()

Creates a new resource (file) with content provided as a native byte array.

ts
static createResourceNative(path: string, content: any, contentType: string): Resource;
Parameter Type Description
path string The absolute path where the resource should be created.
content any The native byte array content.
contentType string The MIME type of the content.
Returns
Type: Resource
Description: The newly created Resource instance.

Parameter	Type	Description
`path`	`string`	The absolute path where the resource should be created.
`content`	`any`	The native byte array content.
`contentType`	`string`	The MIME type of the content.

updateResource()

Updates the content of an existing resource using a string.

ts
static updateResource(path: string, content: string): Resource;
Parameter Type Description
path string The absolute path to the resource to update.
content string The new string content.
Returns
Type: Resource
Description: The updated Resource instance.

Parameter	Type	Description
`path`	`string`	The absolute path to the resource to update.
`content`	`string`	The new string content.

updateResourceNative()

Updates the content of an existing resource using a native byte array.

ts
static updateResourceNative(path: string, content: any): Resource;
Parameter Type Description
path string The absolute path to the resource to update.
content any The new native byte array content.
Returns
Type: Resource
Description: The updated Resource instance.

Parameter	Type	Description
`path`	`string`	The absolute path to the resource to update.
`content`	`any`	The new native byte array content.

deleteResource()

Deletes the resource (file) at the specified path.

ts
static deleteResource(path: string): void;
Parameter Type Description
path string The absolute path of the resource to delete.
Returns
Type: void
Description:

Parameter	Type	Description
`path`	`string`	The absolute path of the resource to delete.

getCollection()

Retrieves a collection (folder) object from the repository by its path.

ts
static getCollection(path: string): Collection;
Parameter Type Description
path string The absolute path to the collection.
Returns
Type: Collection
Description: A Collection instance wrapping the native repository object.

Parameter	Type	Description
`path`	`string`	The absolute path to the collection.

createCollection()

Creates a new collection (folder) at the specified path.

ts
static createCollection(path: string): Collection;
Parameter Type Description
path string The absolute path where the collection should be created.
Returns
Type: Collection
Description: The newly created Collection instance.

Parameter	Type	Description
`path`	`string`	The absolute path where the collection should be created.

deleteCollection()

Deletes the collection (folder) at the specified path.

ts
static deleteCollection(path: string): void;
Parameter Type Description
path string The absolute path of the collection to delete.
Returns
Type: void
Description:

Parameter	Type	Description
`path`	`string`	The absolute path of the collection to delete.

find()

Searches the repository starting from a given path for resources matching a glob pattern.

ts
static find(path: string, pattern: string): void;
Parameter Type Description
path string The starting path for the search.
pattern string The glob pattern to match resource names against (e.g., "*.js").
Returns
Type: void
Description: An array of repository paths (strings) that match the search criteria.

Parameter	Type	Description
`path`	`string`	The starting path for the search.
`pattern`	`string`	The glob pattern to match resource names against (e.g., "*.js").

Resource

getName()

Gets the name of the resource (file name).

ts
getName(): string;
Returns
Type: string
Description: The name.

getPath()

Gets the full repository path of the resource.

ts
getPath(): string;
Returns
Type: string
Description: The repository path.

getParent()

Gets the parent collection (folder) of this resource.

ts
getParent(): Collection;
Returns
Type: Collection
Description: The parent Collection instance.

getInformation()

Gets detailed metadata about the resource.

ts
getInformation(): EntityInformation;
Returns
Type: EntityInformation
Description: The metadata object.

create()

Creates the resource if it does not already exist.

ts
create(): void;
Returns
Type: void
Description:

delete()

Deletes the resource from the repository.

ts
delete(): void;
Returns
Type: void
Description:

renameTo()

Renames the resource within its current collection.

ts
renameTo(name: string): void;
Parameter Type Description
name string The new name for the resource.
Returns
Type: void
Description:

Parameter	Type	Description
`name`	`string`	The new name for the resource.

moveTo()

Moves the resource to a new path.

ts
moveTo(path: string): void;
Parameter Type Description
path string The new absolute path for the resource.
Returns
Type: void
Description:

Parameter	Type	Description
`path`	`string`	The new absolute path for the resource.

copyTo()

Copies the resource to a new path.

ts
copyTo(path: string): void;
Parameter Type Description
path string The new absolute path for the copied resource.
Returns
Type: void
Description:

Parameter	Type	Description
`path`	`string`	The new absolute path for the copied resource.

exists()

Checks if the resource currently exists in the repository.

ts
exists(): boolean;
Returns
Type: boolean
Description: True if the resource exists, false otherwise.

isEmpty()

Checks if the resource (file) is empty (has zero size).

ts
isEmpty(): boolean;
Returns
Type: boolean
Description: True if the content is empty, false otherwise.

getText()

Gets the content of the resource as a text string.

ts
getText(): string;
Returns
Type: string
Description: The text content.

getContent()

Gets the content of the resource as a JavaScript-friendly byte array.

ts
getContent(): void;
Returns
Type: void
Description: The content bytes.

getContentNative()

Gets the content of the resource as its native Java byte array representation.

ts
getContentNative(): void;
Returns
Type: void
Description: The content bytes.

setText()

Sets the content of the resource using a text string. The string is converted to a byte array before saving.

ts
setText(text: string): void;
Parameter Type Description
text string The new text content.
Returns
Type: void
Description:

Parameter	Type	Description
`text`	`string`	The new text content.

setContent()

Sets the content of the resource using a JavaScript byte array. The array is converted to a native byte array before saving.

ts
setContent(content: any): void;
Parameter Type Description
content any The new content bytes.
Returns
Type: void
Description:

Parameter	Type	Description
`content`	`any`	The new content bytes.

setContentNative()

Sets the content of the resource using a native Java byte array.

ts
setContentNative(content: any): void;
Parameter Type Description
content any The new native content bytes.
Returns
Type: void
Description:

Parameter	Type	Description
`content`	`any`	The new native content bytes.

isBinary()

Checks if the resource content is determined to be binary.

ts
isBinary(): boolean;
Returns
Type: boolean
Description: True if binary, false if text.

getContentType()

Gets the content type (MIME type) of the resource.

ts
getContentType(): string;
Returns
Type: string
Description: The content type string.

Collection

getName()

Gets the name of the collection (folder name).

ts
getName(): string;
Returns
Type: string
Description: The name.

getPath()

Gets the full repository path of the collection.

ts
getPath(): string;
Returns
Type: string
Description: The repository path.

getParent()

Gets the parent collection (folder) of this collection.

ts
getParent(): Collection;
Returns
Type: Collection
Description: The parent Collection instance.

getInformation()

Gets detailed metadata about the collection.

ts
getInformation(): EntityInformation;
Returns
Type: EntityInformation
Description: The metadata object.

create()

Creates the collection if it does not already exist.

ts
create(): void;
Returns
Type: void
Description:

delete()

Deletes the collection from the repository.

ts
delete(): void;
Returns
Type: void
Description:

renameTo()

Renames the collection within its current parent.

ts
renameTo(name: string): void;
Parameter Type Description
name string The new name for the collection.
Returns
Type: void
Description:

Parameter	Type	Description
`name`	`string`	The new name for the collection.

moveTo()

Moves the collection to a new path.

ts
moveTo(path: string): void;
Parameter Type Description
path string The new absolute path for the collection.
Returns
Type: void
Description:

Parameter	Type	Description
`path`	`string`	The new absolute path for the collection.

copyTo()

Copies the collection to a new path.

ts
copyTo(path: string): void;
Parameter Type Description
path string The new absolute path for the copied collection.
Returns
Type: void
Description:

Parameter	Type	Description
`path`	`string`	The new absolute path for the copied collection.

exists()

Checks if the collection currently exists in the repository.

ts
exists(): boolean;
Returns
Type: boolean
Description: True if the collection exists, false otherwise.

isEmpty()

Checks if the collection is empty (contains no files or sub-directories).

ts
isEmpty(): boolean;
Returns
Type: boolean
Description: True if empty, false otherwise.

getCollectionsNames()

Gets the names of all sub-collections (folders) within this collection.

ts
getCollectionsNames(): void;
Returns
Type: void
Description: An array of sub-collection names.

createCollection()

Creates a new sub-collection (folder) within this collection.

ts
createCollection(name: string): Collection;
Parameter Type Description
name string The name of the new sub-collection.
Returns
Type: Collection
Description: The newly created Collection instance.

Parameter	Type	Description
`name`	`string`	The name of the new sub-collection.

getCollection()

Gets a specific sub-collection by name.

ts
getCollection(name: string): Collection;
Parameter Type Description
name string The name of the sub-collection.
Returns
Type: Collection
Description: The child Collection instance.

Parameter	Type	Description
`name`	`string`	The name of the sub-collection.

removeCollection()

Removes a sub-collection by name.

ts
removeCollection(name: string): void;
Parameter Type Description
name string The name of the sub-collection to remove.
Returns
Type: void
Description:

Parameter	Type	Description
`name`	`string`	The name of the sub-collection to remove.

getResourcesNames()

Gets the names of all resources (files) within this collection.

ts
getResourcesNames(): void;
Returns
Type: void
Description: An array of resource names.

getResource()

Gets a specific resource (file) by name.

ts
getResource(name: string): Resource;
Parameter Type Description
name string The name of the resource.
Returns
Type: Resource
Description: The child Resource instance.

Parameter	Type	Description
`name`	`string`	The name of the resource.

removeResource()

Removes a resource (file) by name.

ts
removeResource(name: string): void;
Parameter Type Description
name string The name of the resource to remove.
Returns
Type: void
Description:

Parameter	Type	Description
`name`	`string`	The name of the resource to remove.

createResource()

Creates a new resource (file) within this collection.

ts
createResource(name: string, content: string): Resource;
Parameter Type Description
name string The name of the new resource.
content string The string content for the resource.
Returns
Type: Resource
Description: The newly created Resource instance.

Parameter	Type	Description
`name`	`string`	The name of the new resource.
`content`	`string`	The string content for the resource.

EntityInformation

getName()

Gets the name of the entity (resource or collection).

ts
getName(): string;
Returns
Type: string
Description: The name.

getPath()

Gets the full repository path of the entity.

ts
getPath(): string;
Returns
Type: string
Description: The repository path.

getPermissions()

Gets the access permissions for the entity (typically an integer bitmask).

ts
getPermissions(): number;
Returns
Type: number
Description: The permissions value.

getSize()

Gets the size of the resource content in bytes (0 for a collection).

ts
getSize(): number;
Returns
Type: number
Description: The size in bytes.

getCreatedBy()

Gets the user who created the entity.

ts
getCreatedBy(): string;
Returns
Type: string
Description: The creator's name.

getCreatedAt()

Gets the creation timestamp.

ts
getCreatedAt(): Date;
Returns
Type: Date
Description: The creation date and time.

getModifiedBy()

Gets the user who last modified the entity.

ts
getModifiedBy(): string;
Returns
Type: string
Description: The modifier's name.

getModifiedAt()

Gets the last modification timestamp.

ts
getModifiedAt(): Date;
Returns
Type: Date
Description: The modification date and time.

Repository ​

Overview ​

Key Features: ​

Use Cases: ​

Example Usage: ​

Classes ​

Repository ​

getResource() ​

createResource() ​

createResourceNative() ​

updateResource() ​

updateResourceNative() ​

deleteResource() ​

getCollection() ​

createCollection() ​

deleteCollection() ​

find() ​

Resource ​

getName() ​

getPath() ​

getParent() ​

getInformation() ​

create() ​

delete() ​

renameTo() ​

moveTo() ​

copyTo() ​

exists() ​

isEmpty() ​

getText() ​

getContent() ​

getContentNative() ​

setText() ​

setContent() ​

setContentNative() ​

isBinary() ​

getContentType() ​

Collection ​

getName() ​

getPath() ​

getParent() ​

getInformation() ​

create() ​

delete() ​

renameTo() ​

moveTo() ​

copyTo() ​

exists() ​

isEmpty() ​

getCollectionsNames() ​

createCollection() ​

getCollection() ​

removeCollection() ​

getResourcesNames() ​

getResource() ​

removeResource() ​

createResource() ​

EntityInformation ​

getName() ​

getPath() ​

getPermissions() ​

getSize() ​

getCreatedBy() ​

getCreatedAt() ​

getModifiedBy() ​

getModifiedAt() ​

Repository

Overview

Key Features:

Use Cases:

Example Usage:

Classes

Repository

getResource()

createResource()

createResourceNative()

updateResource()

updateResourceNative()

deleteResource()

getCollection()

createCollection()

deleteCollection()

find()

Resource

getName()

getPath()

getParent()

getInformation()

create()

delete()

renameTo()

moveTo()

copyTo()

exists()

isEmpty()

getText()

getContent()

getContentNative()

setText()

setContent()

setContentNative()

isBinary()

getContentType()

Collection

getName()

getPath()

getParent()

getInformation()

create()

delete()

renameTo()

moveTo()

copyTo()

exists()

isEmpty()

getCollectionsNames()

createCollection()

getCollection()

removeCollection()

getResourcesNames()

getResource()

removeResource()

createResource()

EntityInformation

getName()

getPath()

getPermissions()

getSize()

getCreatedBy()

getCreatedAt()

getModifiedBy()

getModifiedAt()