Merge pull request #18 from PAIR-code/iislucas-improve-readme

feat: added exporting for (de)serialization

Author: iislucas

src/index.ts

@@ -23,13 +23,16 @@ import {
   escapeStr,
   unEscapeStr,
   matchTemplate,
+  serialiseTemplate,
+  deserialiseTemplate,
 } from './template';
 import { FewShotTemplate, matchFewShotTemplate } from './fewshot_template';
-import { NamedVar } from './variable';
+import { NamedVar, RegExpVar } from './variable';
 
 export = {
   Template,
   NamedVar,
+  RegExpVar,
   TemplVar,
   escapeStr,
   template,
@@ -38,4 +41,6 @@ export = {
   matchTemplate,
   FewShotTemplate,
   matchFewShotTemplate,
+  serialiseTemplate,
+  deserialiseTemplate,
 };

src/template.ts

@@ -63,7 +63,6 @@ allows parsing of outputs from an LLM to be well typed and know what variable
 will come next.
 
 */
-
 import {
   RegExpVar,
   NamedVar,
@@ -552,3 +551,22 @@ export function template<
     [...varSet]
   );
 }
+
+// Serialization / Deserialization tools
+export type SerialisedTemplate = {
+  escaped: string;
+  vars: string[];
+};
+
+export function serialiseTemplate(templ: Template<string>): SerialisedTemplate {
+  return { vars: Object.keys(templ.vars), escaped: templ.escaped };
+}
+
+export function deserialiseTemplate<Ns extends string>(
+  serialised: SerialisedTemplate
+): Template<Ns> {
+  return new Template(
+    serialised.escaped,
+    serialised.vars.map((v) => new RegExpVar(v as Ns))
+  );
+}