website·Indexed 30 days ago
https://divine-software.github.io/ghostly/API documentation for WSF, featuring modules for web services (@divine/web-service), URI handling and database protocols (@divine/uri, including SQLite, Postgres, MySQL, JDBC, and TDS), and JSX parsing for HTML and XML (@divine/x4e).
The YAMLParser class handles YAML content using the yaml library and StringParser. It supports the following media types: application/yaml, application/x-yaml, text/vnd.yaml, text/x-yaml, and text/yaml.
Important Note: When parsing a multi-document YAML file, only the first document is returned by default. To access all documents, use the FIELDS property.
MultiPartParser class handles MIME multipart messages and multipart/form-data HTML forms. When parsing, it returns a MultiPartData object. Files encountered during parsing are wrapped as CacheURI objects; these temporary files should be cleaned up by calling the finalize function from the @divine/uri module.The AuthScheme class is the base class for all authentication scheme subclasses in the @divine/uri module. While subclasses can be constructed manually, it is generally recommended to use the static create method to instantiate a scheme from an authentication header or a registered authentication name.
Known authentication schemes include:
BasicAuthScheme (Authentication name: "Basic")BearerAuthScheme (Authentication name: "Bearer")HTMLParser class (part of @divine/uri-x4e-parser) is used to convert text/html documents to and from X4E XML objects. It leverages the parse5 library for its underlying HTML processing.divine_uri.URI class is the base class for all URI subclasses in the WSF framework. It defines a basic API for resources that can be described by a URI, integrating pluggable parsers, serializers, encoders, decoders, and authentication methods. It supports standard URLs (like file: and http:) as well as non-URL URIs such as database connections.divine_uri.Parser class serves as the base class for all parser subclasses. While it can be instantiated manually, it is primarily used via its static parse and serialize methods to handle serialization and deserialization of data based on specific media types.CORSFilter is a helper class that implements the WebFilter interface. It provides a default CORS implementation where all origins, methods, and headers are allowed for 10 minutes, while credentials are disallowed by default. To customize the CORS policy, developers should extend CORSFilter and override its protected methods.The divine_uri namespace provides a comprehensive set of tools for URI and data handling:
URI, HTTPURI, FileURI, DatabaseURI, CacheURI.JSONParser, YAMLParser, TOMLParser, CSVParser, FormParser, MultiPartParser, EventStreamParser.Base64Encoder, ZlibEncoder, QuotedPrintableEncoder, IdentityEncoder.AuthScheme, BasicAuthScheme, BearerAuthScheme, BasicCredentials, BearerCredentials.DBQuery, DBResult, DBError, DBMetadata.Credentials, Metadata, Selector, Finalizable.@divine/ghostly-engine and @divine/ghostly-runtime modules now include full TypeScript definitions. Additionally, Ghostly v2 supports 'attachments', enabling templates to produce secondary results (such as CSV files) during model initialization alongside primary output.The StringParser class (part of the @divine/uri module) is a specialized parser that converts between text and bytes. It is primarily used for the text/plain media type and serves as a foundation for other string-based parsers. It supports the following media type parameters:
charset: The character set to use (defaults to utf8).x-bom: Determines whether to add a byte-order-mark during serialization (default is absent).The HTTPURI class is a subclass of URI used to handle http: and https: protocols for accessing web services. It handles redirects automatically. To customize the handler, you can use addSelector to attach the following selectors:
HTTPParamsSelector: For general handler configuration.AuthSelector: For providing authentication credentials.HeadersSelector: For adding custom HTTP headers.