@formata/stof 0.9.6

package/dist/doc.js

@@ -0,0 +1,194 @@
+//
+// Copyright 2025 Formata, Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// @deno-types="./pkg/stof.d.ts"
+import init, { Stof, StofFunc } from './pkg/stof.js';
+// @deno-types="./pkg/stof.d.ts"
+export * from './pkg/stof.js';
+/**
+ * Template function for a document.
+ * Stof must be initialized before with `await Doc.initialize()`.
+ */
+export function stof(strings, ...values) {
+    const doc = new StofDoc();
+    let result = '';
+    for (let i = 0; i < strings.length; i++) {
+        result += strings[i];
+        if (i < values.length)
+            result += values[i];
+    }
+    doc.parse(result);
+    return doc;
+}
+/**
+ * Stof document.
+ */
+export class StofDoc {
+    /**
+     * Initialize Stof WASM.
+     */
+    static async initialize(data) {
+        // @ts-ignore this exists
+        return StofDoc.initialized ?? await (StofDoc.initialized = init(data));
+    }
+    /**
+     * Constructor.
+     * Make sure to call initalize before using.
+     */
+    constructor(stof = new Stof()) {
+        this.stof = stof;
+    }
+    /**
+     * Create & initialize (if needed).
+     */
+    static async new() {
+        await StofDoc.initialize();
+        return new StofDoc();
+    }
+    /**
+     * Parse a JS object into a StofDoc.
+     */
+    static async parse(obj) {
+        const doc = await StofDoc.new();
+        doc.stof.objImport(obj, null);
+        return doc;
+    }
+    /**
+     * Sync parse a JS object into a StofDoc.
+     * Note: make sure initialize has been called on the wasm.
+     */
+    static sync_parse(obj) {
+        const doc = new StofDoc();
+        doc.stof.objImport(obj, null);
+        return doc;
+    }
+    /**
+     * Parse string source, array, or a JS record.
+     */
+    parse(src, format = "stof", node = null, profile = 'prod') {
+        if (typeof src === 'string') {
+            return this.stof.stringImport(src, format, node, profile);
+        }
+        else if (src instanceof Uint8Array) {
+            return this.stof.binaryImport(src, format, node, profile);
+        }
+        return this.stof.objImport(src, node);
+    }
+    /**
+     * Add JS library function.
+     */
+    // deno-lint-ignore ban-types
+    lib(library, name, func, is_async = false) {
+        this.stof.js_library_function(new StofFunc(library, name, func, is_async));
+    }
+    /**
+     * Run this document with a given set of Stof attributes.
+     * Will run all #[main] functions by default.
+     */
+    async run(attr = 'main') {
+        return await this.stof.run(attr);
+    }
+    /**
+     * Run this document with a given set of Stof attributes (synchronously).
+     * Will run all #[main] functions by default.
+     * Note: any async TS library functions called will not work with synchronous exec (ex. fetch).
+     */
+    sync_run(attr = 'main') {
+        return this.stof.sync_run(attr);
+    }
+    /**
+     * Call a specific Stof function by path/name.
+     */
+    async call(path, ...args) {
+        if (!path.includes('.'))
+            path = 'root.' + path; // assume root node if not specified
+        return await this.stof.call(path, args);
+    }
+    /**
+     * Call a specific Stof function by path/name.
+     * Note: any async TS library functions called will not work with synchronous exec (ex. fetch).
+     */
+    sync_call(path, ...args) {
+        if (!path.includes('.'))
+            path = 'root.' + path; // assume root node if not specified
+        return this.stof.sync_call(path, args);
+    }
+    /**
+     * Get a value from this graph by path and an optional starting object ID.
+     */
+    get(path, start_obj_id = null) {
+        if (!path.includes('.'))
+            path = 'self.' + path;
+        return this.stof.get(path, start_obj_id);
+    }
+    /**
+     * Set a value on this graph by path.
+     * Returns true if successfully set.
+     */
+    set(path, value, start_obj_id = null) {
+        if (!path.includes('.'))
+            path = 'self.' + path;
+        return this.stof.set(path, value, start_obj_id);
+    }
+    /**
+     * Stringify this doc into a format (JSON by default).
+     */
+    stringify(format = "json", node = null) {
+        return this.stof.stringExport(format, node);
+    }
+    /**
+     * Blobify this doc (or a specific node) into a format (JSON by default).
+     */
+    blobify(format = "json", node = null) {
+        return this.stof.binaryExport(format, node);
+    }
+    /**
+     * To JS record.
+     */
+    record(node = null) {
+        return JSON.parse(this.stringify('json', node));
+    }
+    /*****************************************************************************
+     * Network.
+     *****************************************************************************/
+    /**
+     * Send Stof doc string body as an HTTP request.
+     */
+    static async send(url, stof, method = 'POST', bearer, headers = {}) {
+        headers['Content-Type'] = 'application/stof';
+        if (bearer !== undefined)
+            headers['Authorization'] = `Bearer ${bearer}`;
+        return await fetch(url, {
+            method,
+            headers: headers,
+            body: stof
+        });
+    }
+    /**
+     * Send this document ('bstf' format) as an HTTP request.
+     */
+    async send(url, method = 'POST', bearer, headers = {}) {
+        headers['Content-Type'] = 'application/bstf';
+        if (bearer !== undefined)
+            headers['Authorization'] = `Bearer ${bearer}`;
+        const body = this.stof.binaryExport('bstf', null); // Uint8Array
+        return await fetch(url, {
+            method,
+            headers: headers,
+            body
+        });
+    }
+}
+//# sourceMappingURL=doc.js.map

package/dist/doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc.js","sourceRoot":"","sources":["../doc.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,oDAAoD;AACpD,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AAEF,gCAAgC;AAChC,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACrD,gCAAgC;AAChC,cAAc,eAAe,CAAC;AAG9B;;;GAGG;AACH,MAAM,UAAU,IAAI,CAAC,OAA6B,EAAE,GAAG,MAAiB;IACpE,MAAM,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC1B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAClB,OAAO,GAAG,CAAC;AACf,CAAC;AAGD;;GAEG;AACH,MAAM,OAAO,OAAO;IAQhB;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAc;QAClC,yBAAyB;QACzB,OAAO,OAAO,CAAC,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAGD;;;OAGG;IACH,YAAY,OAAa,IAAI,IAAI,EAAE;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG;QACZ,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3B,OAAO,IAAI,OAAO,EAAE,CAAC;IACzB,CAAC;IAGD;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAA4B;QAC3C,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;QAChC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,GAAG,CAAC;IACf,CAAC;IAGD;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,GAA4B;QAC1C,MAAM,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,GAAG,CAAC;IACf,CAAC;IAGD;;OAEG;IACH,KAAK,CAAC,GAAkD,EAAE,SAAiB,MAAM,EAAE,OAAsB,IAAI,EAAE,UAA2B,MAAM;QAC5I,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;aAAM,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAGD;;OAEG;IACH,6BAA6B;IAC7B,GAAG,CAAC,OAAe,EAAE,IAAY,EAAE,IAAc,EAAE,WAAoB,KAAK;QACxE,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC/E,CAAC;IAGD;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,OAA0B,MAAM;QACtC,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAGD;;;;OAIG;IACH,QAAQ,CAAC,OAA0B,MAAM;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAGD;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,GAAG,IAAe;QACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC,oCAAoC;QACpF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAGD;;;OAGG;IACH,SAAS,CAAC,IAAY,EAAE,GAAG,IAAe;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC,oCAAoC;QACpF,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAGD;;OAEG;IACH,GAAG,CAAC,IAAY,EAAE,eAA8B,IAAI;QAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC7C,CAAC;IAGD;;;OAGG;IACH,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,eAA8B,IAAI;QAChE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC;IAGD;;OAEG;IACH,SAAS,CAAC,SAAiB,MAAM,EAAE,OAAsB,IAAI;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAGD;;OAEG;IACH,OAAO,CAAC,SAAiB,MAAM,EAAE,OAAsB,IAAI;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAGD;;OAEG;IACH,MAAM,CAAC,OAAsB,IAAI;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;IAGD;;mFAE+E;IAE/E;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,IAAY,EAAE,SAAiB,MAAM,EAAE,MAAe,EAAE,UAAkC,EAAE;QACvH,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC7C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,MAAM,EAAE,CAAC;QACxE,OAAO,MAAM,KAAK,CAAC,GAAG,EAAE;YACpB,MAAM;YACN,OAAO,EAAE,OAAsB;YAC/B,IAAI,EAAE,IAAI;SACb,CAAC,CAAC;IACP,CAAC;IAGD;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,SAAiB,MAAM,EAAE,MAAe,EAAE,UAAkC,EAAE;QAClG,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC7C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,MAAM,EAAE,CAAC;QACxE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,aAAa;QAChE,OAAO,MAAM,KAAK,CAAC,GAAG,EAAE;YACpB,MAAM;YACN,OAAO,EAAE,OAAsB;YAC/B,IAAI;SACP,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/pkg/stof.d.ts

@@ -0,0 +1,141 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class Stof {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Binary export (Uint8Array), using a format of choice.
+   * Format can also be a content type (for HTTP-like situations).
+   */
+  binaryExport(format: string, node: any): any;
+  /**
+   * Binary import (Uint8Array), using a format of choice.
+   * Format can also be a content type (for HTTP-like situations).
+   */
+  binaryImport(bytes: any, format: string, node: any, profile: string): boolean;
+  /**
+   * Import a JS object value.
+   */
+  objImport(js_obj: any, node: any): boolean;
+  /**
+   * String export, using a format of choice.
+   */
+  stringExport(format: string, node: any): string;
+  /**
+   * String import, using a format of choice (including stof).
+   */
+  stringImport(src: string, format: string, node: any, profile: string): boolean;
+  /**
+   * Insert a JS function as a library function, available in Stof.
+   */
+  js_library_function(func: StofFunc): void;
+  /**
+   * Get a value from this graph using the Stof runtime (all language features supported).
+   */
+  get(path: string, start: any): any;
+  /**
+   * Construct a new document.
+   */
+  constructor();
+  /**
+   * Run functions with the given attribute(s) in this document.
+   * Attributes defaults to #[main] functions if null or undefined.
+   */
+  run(attributes: any): Promise<string>;
+  /**
+   * Set a value onto this graph using the Stof runtime.
+   */
+  set(path: string, value: any, start: any): boolean;
+  /**
+   * Call a singular function in the document (by path).
+   * If no arguments, pass undefined as args.
+   * Otherwise, pass an array of arguments as args.
+   */
+  call(path: string, args: any): Promise<any>;
+  /**
+   * Parse Stof into this document, optionally within the specified node (pass null for root node).
+   */
+  parse(stof: string, node: any, profile: string): boolean;
+  /**
+   * Synchronous run functions with the given attribute(s) in this document.
+   * Attributes defaults to #[main] functions if null or undefined.
+   * Async TS lib functions will not work with this, but it will be faster.
+   */
+  sync_run(attributes: any): string;
+  /**
+   * Synchronous call a singular function in the document (by path).
+   * If no arguments, pass undefined as args.
+   * Otherwise, pass an array of arguments as args.
+   * Async TS lib functions will not work with this, but it will be faster.
+   */
+  sync_call(path: string, args: any): any;
+}
+
+export class StofFunc {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new Stof function from a JS function.
+   */
+  constructor(library: string, name: string, js_function: any, is_async: boolean);
+}
+
+export function start(): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_stoffunc_free: (a: number, b: number) => void;
+  readonly stoffunc_new: (a: number, b: number, c: number, d: number, e: any, f: number) => number;
+  readonly __wbg_stof_free: (a: number, b: number) => void;
+  readonly start: () => void;
+  readonly stof_binaryExport: (a: number, b: number, c: number, d: any) => [number, number, number];
+  readonly stof_binaryImport: (a: number, b: any, c: number, d: number, e: any, f: number, g: number) => [number, number, number];
+  readonly stof_call: (a: number, b: number, c: number, d: any) => any;
+  readonly stof_get: (a: number, b: number, c: number, d: any) => any;
+  readonly stof_js_library_function: (a: number, b: number) => void;
+  readonly stof_new: () => number;
+  readonly stof_objImport: (a: number, b: any, c: any) => [number, number, number];
+  readonly stof_parse: (a: number, b: number, c: number, d: any, e: number, f: number) => [number, number, number];
+  readonly stof_run: (a: number, b: any) => any;
+  readonly stof_set: (a: number, b: number, c: number, d: any, e: any) => number;
+  readonly stof_stringExport: (a: number, b: number, c: number, d: any) => [number, number, number, number];
+  readonly stof_stringImport: (a: number, b: number, c: number, d: number, e: number, f: any, g: number, h: number) => [number, number, number];
+  readonly stof_sync_call: (a: number, b: number, c: number, d: any) => [number, number, number];
+  readonly stof_sync_run: (a: number, b: any) => [number, number, number, number];
+  readonly wasm_bindgen__convert__closures_____invoke__h53d5cf04cab8438f: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h72b14ab7db8750ca: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__ha84735728bfe97a9: (a: number, b: number, c: any, d: any) => void;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_externrefs: WebAssembly.Table;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;