Solidocity NPM

Data access library for Solid PODs. Simple and clear.

compatible with NodeJS
Typescript decorators metadata definitions

Before usage you should provide authenticated fetch from your auth library, solid-auth-fetcher for example:

import {useFetch} from "solidocity";
useFetch(fetch);

Really simple:

const profile = new Profile(session.webId);
await profile.Init();
console.log(profile.Me.FullName);

profile.Me.Role = 'God of development';
profile.Me.Save();
await profile.Save();

Define your predicate schema:

const schema = {
   Person: '<person type definition URI>`,
   children: '<children predicate  URI>`
}

Define your models:

export class Profile extends Document {

    @entityField(Person)
    public Me: Person;

    @entitySet(ContextEntity, {isArray: true})
    public OtherPeople: EntitySet<Person>;

}


@entity(schema.Person)
export class Person extends Entity{
    @field(vcard.fn)
    public FullName: string;

    @field(vcard.role)
    public Role: string;

    @field(schema.children, {type: "ref", isArray: true, isOrdered: true})
    public Children: ValuesSet<string>;

}

supports multiple values and ordered arrays
supports ACL-files for reading and writing permissions
auth functions
- useFetch(fetch) - registers fetch function
Document base class representing file in POD.
- constructor(uri) - file uri
- async Init() - loads file, on error creates it, on error throws it. All fields of Document will be available after Init.
- async Save() - saves document ot file on POD; on error throws it.
- Acl: AclDocument - control document permissions.
- Subscribe() - reloads document on external changes
- on('update'|'delete', listener) - subscribe for changes
Entity base class representing all triplets with same Subject in POD file
- constructor(uri) for internal use only
- Save() saves entity changes into document but not to a server
- Assign(data) same as Object.assign
- Remove() deletes entity from document
- Id entity URI
- Documententity owner
EntitySet used for unordered array of entities
- Items: ReadonlyArray<TEntity> should not be changed by push, pop, unshift etc.
- Add(): TEntity creates new item and adds it to Document
ValuesSet used for ordered array of items (string | References | Date | number)
AclDocument
- async InitACL(owner: ownerURI, ...modes: Reference[]) creates new .acl file that grants control,read,write to owner and choosed rights to everybody

@field(predicate, {
    type: 'string' | 'ref' | 'Date' | 'decimal', // string by default
    isArray: boolean, // false by default
    isOrdered: boolean, // false by default
})

Decorated field should has type