@vertesia/memory 0.43.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,421 @@
+# Memory Pack
+
+This is the core of the Composable memory Pack library.
+It defines the memory pack commands and provide an API to build and read memory packs.
+
+A memory pack is an indexed tar file containing a `metadata.json` and other random files (images, documents, text files etc.). The `metadata.json` file is defining the properties of a memory pack. The metadata is used to describe the memory and the other files in the tar can be used to hold the additional content you need in order to create a context for the interaction with a target LLM.
+
+To build a memory pack you must use the memory pack API or the `memo` application provided by `@vertesia/memory-cli` package. The tar contains a special file named `.index` which is used to index the tar content so that the tar entries can be quickly extracted from the tar without nneeding to untar the entire content.
+
+## Memory Pack Recipe
+
+A recipe is a typescript file that is used to build a memory pack.
+The recipe can contain any javascript code but it must use the builtin commands to create the memory TAR file.
+
+A memory tpack recipe has the following structure:
+
+```js
+import { copy, ... other commands ... } from "@vertesia/memory-commands";
+
+// You can optionally extend an existing memory pack
+await from("path/to/memory.tar")
+
+/** then you can build the memory tar content using builtin commands
+ * You can either use the bult-in commands or `exec` to run a shell command
+ */
+
+// ... Your commands here ...
+
+/**
+ * At the end of the file you must export the memory pack metadata.
+ * This is a JSON object which holds the properties to be used when creating LLM interactions.
+ */
+export default {
+    someProperty: "hello",
+    ...
+}
+```
+
+## Memory Pack Commands.
+
+The only dependency you need to import in your recipe ts file is the `@becmposable/memory-commands` package. This package contains all the buil-in commands which are grouped in two categories: execution commands and content loading commands:
+
+### Context commands
+1. **vars** - Get the build user variables
+2. **tmpdir** - Get or create a temporary directory for use while building
+3. **getBuilder** - Get the builder instance.
+
+### Execution commands
+1. **from** - Extends an existing memory pack (a tar file)
+2. **exec** - Execute a shell command.
+3. **copy** - Copy a file to the tar. The file content can be transformed using the built-in transformers. See the [copy command](#copy) for more details.
+4. **copyText** - Copy an inline text or string variable as a tar entry.
+5. **build** - Build an external recipe.
+
+### Content loading commands
+
+These commands can be used to fetch content from files. The result is returned as a variable which will only fetch the content when used. All these commands supports globs as argument to fretch content from multiple files. When a glob is used the result will alwaysbe an array of variables.
+1. **content** - fetch the text content from a text file.
+2. **json** - fetch a JSON object from a json file.
+3. **pdf** - extract the text content from a PDF file.
+4. **docx** - extract the text content from a Docx file.
+5. **media** - Load an image with an optional conversion. The image is exported as base64 text, when the variable is referenced in the exported memory metadata.
+
+#### vars
+
+**Signature:** `vars (): Record<string,any>`
+
+A command that returns the user variables which were specified when invoking the memory pack build.
+These variables can be used to parametrize the recipe. When using the `memo` cli application (i.e. `@vertesia/memory-cli`) you can pass vars to the recipe by using command line parameters which starts with a `--var-` prefix.
+
+**Example:** `--var-language fr` will produce a property `language` whith a value of `'fr'`.
+
+**Usage:**
+```js
+import { vars } from "@vertesia/memory-commands"
+
+const { language } = vars();
+```
+
+#### tmpdir
+
+**Signature:** `tmpdir (): string`
+
+Get or create a temporary directory. If the directory was not yet created it will be created and its path returned.
+
+If created, the temporary directory will be automatically removed at the end of the build.
+
+**Usage:**
+
+```js
+import { tmpdir } from "@vertesia/memory-commands";
+
+const wd = tmpdir();
+
+await exec(`ls -al > ${wd}/text.txt`);
+```
+
+### getBuilder
+
+**Signature:** `getBuilder (): Builder`
+
+Get the instance of the builder which is used to build the current recipe ts file.
+
+
+### from
+
+**Signature:** `from (location: string, options?: FromOptions): void`
+
+The from command load an existing memory pack tar as a source of the current pack being built. You can filter which files and metadata properties will be included from the soruce tar by specifying a `files` filter and a metadata properties `projection`.
+
+The `from` command is an asynchronous operation so you need to `await` for its completion.
+
+The shape of the `FromOptions` is:
+
+```ts
+{
+    files?: string[];
+    projection?: Record<string, boolean | 0 | 1>;
+}
+```
+The `files` filter is an array of globs as supported by the [micromatch](https://www.npmjs.com/package/micromatch) library. You can either include files using globs expressions or fiels by prepending the glob expression with an `!` character.
+
+The `projection` is an object which map keys to a truthy or falsy value. You can either use false or true to exclude or include properties not both.
+
+*Example:*
+
+```js
+import { vars, from } from "@vertesia/memory-commands"
+await from("./memory-source.tar", {
+    files: ["images/*.png"],
+    projection: {
+        name: true,
+        language: true,
+    }
+})
+// export a new metadata object
+export default {
+    theme: vars.theme || 'dark'
+}
+```
+
+The memory pack built above will contain all the `images/*.png` files from the source tar and the metadata JSON object will contain the `name` and `language` properties from the source memory pack metadata and will add a new metadata property named `theme`.
+
+
+### exec
+
+**Signature:** `exec (cmd: string, options?: ExecOptions): Promise<void | string>`
+
+Execute a shell command. You can execute a pipe of shell commands or use stdout redirection at the end of the command:
+
+The `exec` command is asynchronous so you need to use await when incoking it. If no output redirection is specified then the output will be returned as a string from the `exec()` function
+
+**Example:**
+
+```javascript
+import { tmpdir, exec } from "@vertesia/memory-commands"
+const wd = tmpdir();
+const output = await exec("cat some/file | wc -l")
+await exec(`cat some/file | wc -l > ${wd}out.txt`)
+```
+
+### copy
+
+**Signature:** `copy (location: SourceSpec, path: string, options?: CopyOptions): void`
+
+This command will copy the content of a file to a tar entry specified by the `path` argument.
+The `location` argument specify from source from where the content is copied.
+It may be either a `string` or a `ContentSource` object. ContentSource objects are returned by any of the [Content Loading Commands](#content-loading-commands).
+
+If location is a string it will be expected to point to a file path or to a glob expression.
+If a glob expression is used the the `copy` operation will copy the content of all the matching files. You can, in that case, specify a path rewrite expression as the `path` argument.
+
+Youn can transform the file content when copying it to the tar by using the `options` argument. The shape of the options is:
+
+```ts
+export interface CopyOptions {
+    media?: {
+        max_hw?: number;
+        format?: "jpeg" | "png";
+    };
+    extractText?: boolean | string;
+}
+```
+
+You can convert images by specfying a max height or widtth and / or an output image format. For documents like pdf or docx you can specify `extractText: "pdf" | "docx" | boolean`. If true is specified the type of text extraction will be guessed from the file extension.
+
+**Example:**
+
+```js
+import { exec, copy, tmpdir } from "@vertesia/memory-commands"
+const wd = tmpdir();
+await exec(`cat some/file > ${wd}/out.txt`)
+copy(`${wd}/out.txt`, 'out.txt');
+copy('./my-project/src/**/*.ts', './my-project/src!sources/*')
+```
+
+The rewrite expression in the example above `./my-project/src!sources/*` means: strip the prefix `./my-project/src` fromt he copied file and prefix the remaining od the path with the value `sources/`.
+
+#### Path rewrite expressions
+
+A path rewrite expression is composed of two parts:
+1. an optional prefix separated by a `!` charcater from the rest of the path. If present this prefix will be removed from the matched path.
+If no prefix is specified then the entrie directory part of the matched path will be removed.
+2. A mandatory suffix which is describing how to rewrite the matched path. The suffix may contain either a wildcard `*` which will be replaced with the matched path (without the removed prefix), either a combination of the followinf variables:
+    * `%n` - the file name without the extension
+    * `%e` - the extension
+    * `%f` - the file name including the extension
+    * `%d` - the directory path (not including the removed prefix)
+    * `%i` - the 0 based index of the file in the matched array of files.
+
+**Examples:**
+
+```js
+// copy all .ts files flatened in the sources directory (the directory structure is not preserved)
+copy("work/docs/project1/src/**/*.ts", "sources/*")
+// copy all .ts files  in the sources directory and recreate the subdirectories structure inside src/
+copy("work/docs/project1/src/**/*.ts", "work/docs/project1/src!sources/*")
+// Remove the work/ prefix and preserver the same subdirectories structure including images/
+// and replace the file extension with .png
+copy("work/images/**/*.png", "work!%d/%n.jpeg")
+// Copy all images inaide a images/ folder without preserving subdirectories and append the index of the image
+copy("work/images/**/*.png", "images/%n-%i.%e")
+```
+
+In the last example for the mnatched files: `work/images/header/home.png` and `work/images/footer/logo.png` the result will be: `images/home-0.png`, `images/logo-1.png`
+
+### copyText
+
+**Signature:** `copyText (text: string, path: string): void`
+
+This command will create a new entry in the target memory pack tar using the content you specified through the `text` argument. The tar entry path is specified by the `path` argument.
+
+```js
+import { exec, copyText } from "@vertesia/memory-commands"
+const content = await exec(`cat some/file`)
+copyText(content.trim(), 'content.txt')
+```
+
+### build
+
+**Signature:** `build (recipePath: string, options?: BuildOptions): void`
+
+Build a memory pack from a recipe file. You can use this command if you need to build multiple memory packs.
+
+The `BuildOptions` options have the following shape:
+
+```ts
+export interface BuildOptions {
+    indent?: number;
+    /**
+     * the path to save the output. Defaults to 'memory.tar'.
+     * If no .tar extension is present it will be added
+     */
+    out?: string;
+
+    /**
+     * If set, suppress logs. Defaults to false.
+     */
+    quiet?: boolean;
+
+    /**
+     * If true, compress the output (tar or json) with gzip. Defaults to false.
+     */
+    gzip?: boolean;
+
+    /**
+     * Vars to be injected into the script context as the vars object
+     */
+    vars?: Record<string, any>;
+
+    /**
+     * Optional publish action
+     * @param file
+     * @returns the URI of the published memory
+     */
+    publish?: (file: string, name: string) => Promise<string>
+}
+```
+
+**Usage:**
+
+```js
+import { build, tmpdir } from "@vertesia/memory-commands";
+const wd = tmpdir();
+await build("./some/recipe.ts", { out: `${wd}}/child-memory`});
+```
+
+### content
+
+**Signature:** `content (location: string, encoding?: BufferEncoding): ContentObject | ContentObject[]`
+
+If the location is a glob expression then an arry of `ContentObject` is returned. A `ContentObject` implements `ContentSource` so it can be used as the location argument of the copy operation.
+The actual cotnent of a file is only fetched (and trasformed) only when the ContentObject is used: either a method of the object is used, either it is assigned to a value of a metadata property.
+
+The `content` command simply load the content of the given file(s) as a text using an optional encoding. The default encoding is "utf-8".
+
+### json
+
+**Signature:** `json (location: string) => ContentObject | ContentObject[]`
+
+Load a JSON object from a json file. When assigned as a metadata property the content  will by transformed in a JSON object.
+
+### pdf
+
+**Signature:** `pdf (location: string) => PdfObject | PdfObject[]`
+
+Load a PdfObject form a pdf file. When assigned as a metadata property the PdfObject is transformed to the text representation of the PDF.
+
+**Example:**
+
+```js
+import { pdf } from "@vertesia/memory-commands";
+
+const doc = pdf("./my-doc.pdf")
+
+export default {
+    textContent: doc
+}
+```
+
+In the example above the PDF text will be extracted from the pdf and ibjected as the textContent property ion the memory pack metadata.
+
+### docx
+
+Load a DocxObject form a docx file. When assigned as a metadata property the DocxObject is transformed to the text representation of the Docx.
+
+**Signature:** `docx (location: string) => DocxObject | DocxObject[]`
+
+### media
+
+**Signature:** `json (location: string, options?: MediaOptions) => MediaObject | MediaObject[]`
+
+
+Load a MediaObject form a docx file. When assigned as a metadata property the MediaObject is transformed to text representation of the image which is the base64 encoded image.
+
+The media command accepts an additional argument which has the shape:
+
+```
+export interface MediaOptions {
+    max_hw?: number;
+    format?: "jpeg" | "png";
+}
+```
+
+You can thus convert the image before using it.
+
+**Example:**
+
+```js
+import { pdf } from "@vertesia/memory-commands";
+
+const images = media("./images/*.jpeg")
+
+export default {
+    images: images
+}
+```
+
+In the example above the an array of images encoded as base64 will be injected in the `images` property pf the memory pack metadata.
+
+
+### Custom commands
+
+To create custom commands you have 2 options. Either you write the command in as a command line application and invoke it through the `exec` command, either you write a javascript function, package it in an external library and the import it in the recipe ts file.
+
+Here is a template of custom command functions:
+
+```js
+import { getBuilder } from "@vertesia/memory-commands";
+import fs from "node:fs";
+
+export myCommand(message:string) {
+    const wd = builder.tmpdir();
+    // this is the current instance of the builder being used to build the memory pack.
+    const builder = getBuilder();
+    // you can add a variable in the build vars:
+    builder.vars.greeting = 'hello world!';
+    // or write a file named greeting.txt in the current build tmpdir
+    fs.writeFileSync(`${wd}/greeting.txt`, "hello world!", "utf-8");
+    // or create a tar entry named greeting.txt
+    builder.copyText("hello world!", "greeting.txt");
+    // refer to Builder API for other operations.
+}
+```
+
+## Examples
+
+### Release Highlights
+
+This example builds a memory pack with the information on which issues were fixed between to commit SHA.
+
+```js
+import { copy, copyText, exec, tmpdir, vars } from "@vertesia/memory-commands";
+
+const { start, end } = vars();
+if (!start || !end) {
+    console.error("Please provide start and end tags using --var-start and --var-end");
+    process.exit(1);
+}
+
+const wd = tmpdir();
+
+console.log(`Retrieving issues between ${start}and ${end}...`)
+// Get list of commit logs containing '#' between the two tags and extract unique issue numbers
+const issue_numbers = await exec(`git log ${start}..${end} --oneline | grep -o '#[0-9]\\+' | sed 's/#//' | sort -u`) as string;
+
+for (const issue of issue_numbers.trim().split("\n")) {
+    console.log(`Processing issue #${issue}`)
+    const issue_content = await exec(`gh issue view ${issue}`) as string;
+    copyText(issue_content, `issues/${issue}.txt`);
+}
+
+console.log("Generating diff");
+await exec(`git diff --submodule=diff ${start}...${end} > ${wd}/range_diff.txt`)
+copy(`${wd}/range_diff.txt`, "range_diff.txt");
+
+export default {
+    from_version: start,
+    release_version: end,
+}
+```